oracle. chapter.S.com Please include your name.
Report Builder Reference
xvii
. and page number below: ________________________________________________________________ ________________________________________________________________ ________________________________________________________________ ________________________________________________________________ ________________________________________________________________ ________________________________________________________________ ________________________________________________________________ Please send your comments to: Oracle Applications Documentation Manager Oracle Corporation 500 Oracle Parkway Redwood Shores. CA 94065 U. Or send comments by e-mail to: globedoc@us. address. please write the topic.A. • Did you find any errors? • Is the information presented clearly? • Are the examples correct? Do you need more examples? • What features did you like? If you found any errors or have any other suggestions for improvement. Your feedback is an important part of our revision process.Send Us Your Comments
Reader’s Comment Form – A73174-01
Oracle Corporation welcomes your comments about this manual’s quality and usefulness. and telephone number for a reply: ________________________________________________________________ ________________________________________________________________ ________________________________________________________________ Thank you for your help.

xviii
Report Builder Reference
.

Release 6i. This reference guide includes information to help you effectively work with Oracle Developer Report Builder and contains detailed information about the following: • Built ins • • Triggers Properties
• Executables This preface explains how this reference is organized and introduces other sources of information that can help you use Oracle Reports.
Report Builder Reference
xix
.Preface
Welcome to the Oracle Reports Reference.

SQL reserved words. boldface Boldface is used to indicate user interface items such as menu choices and buttons. and path names.
Related Publications
You may also wish to consult the following Oracle documentation: Title Part Number Oracle Developer: Guidelines A58766 for Building Applications SQL*Plus User’s Guide and A24801 Reference Version 3.1
xx
Report Builder Reference
. lowercase Lowercase characters in a command statement represent a variable. such as the elements of an application window. and keywords. In commands. Your prompt may differ. Substitute an appropriate value. Text typed on a PC is not casesensitive unless otherwise noted. subdirectories.Prerequisites
You should be familiar with your computer and its operating system. UPPERCASE Uppercase characters within the text represent command names. you should know the commands for deleting and copying files and understand the concepts of search paths. C> C> represents the DOS prompt. Taskbar or Task Manager. For example. and Registry. punctuation other than brackets and vertical bars must be entered exactly as shown. You should also be familiar with such programs as the Explorer. Refer to your Microsoft Windows 95 or NT and DOS product documentation for more information. You should understand the fundamentals of Microsoft Windows.
Notational Conventions
The following typographical conventions are used in this guide: Convention Meaning fixed-width font Text in a fixed-width font indicates commands that you enter exactly as shown.

Built-Ins
Report Builder Reference
1
.

functions.Built-in packages
Oracle provides several packaged procedures which you can use when building or debugging your PL/SQL-based applications. and exceptions in the following client-side built-in packages: • Oracle Developer built-in packages • SRW built-in packages
2
Report Builder Reference
. Your PL/SQL code can make use of the procedures.

SET_PDF_ACTION procedure. c:\orawin\bin\rwrun60 userid=scott/tiger report=example.SET_ATTR is still supported for compatibility. Note: An object that is associated with an action cannot also be the source of a Web link.SET ATTR to set the ACTION attribute. but it is highly recommended that you use the new.rdf'. n ACTION should only be set in the following triggers: n Format
ACTION example
Note: This example illustrates using SRW. Setting this attribute via SRW.srw.SET_ATTR is still supported for compatibility. but it is highly recommended that you use the new. */ function B_2FormatTrigger return boolean is begin srw. end.action := 'c:\orawin\bin\rwrun60' || 'userid=scott/tiger ' || 'report=example.SET_PDF_ACTION procedure.g. return (TRUE).rdf or /usr/local/bin/phone smith)
ACTION restrictions
n ACTION is only available for PDF output. It is now more convenient to set this attribute using the SRW.set_attr(0. srw.attr. simplified procedure.attr..ACTION_ATTR. Values Any valid command line on the local machine (e.
4
Report Builder Reference
. Setting this attribute via SRW.mask := srw.ACTION
New Feature: It is now more convenient to set this attribute using the SRW.attr). simplified procedure. srw.
/* The format trigger below defines an “action” (in ** this case a call to the Reports Runtime) that ** should be executed when the user clicks on the ** boilerplate object B_2. Description Is a command line that will be executed on the local machine when the object is clicked in the PDF viewer.

where number is a number assigned to a packaged Report Builder printer escape sequence or a printer escape sequence that you created. but it is highly recommended that you use the new.
Report Builder Reference
5
. The printer escape sequence is inserted after the object is triggered to print but before it has actually printed. simplified procedure. Values A string of the form &number.SET_ATTR is still supported for compatibility. Description Is a reference to the printer escape sequence to be executed after each line of the object. Setting this attribute via SRW. AFTCODE is only used when running your report in character-mode.AFTCODE
New Feature: It is now more convenient to set this attribute using the SRW.SET_AFTER_PRINTING_CODE procedure.

If you specify a file.FILE_ESCAPE or SRW. Setting this attribute via SRW. the File searching method is used to find it.AFTFORM_ESCAPE
New Feature: It is now more convenient to set this attribute using the SRW. n AFTFORM_ESCAPE_VALUE can be a filename or a text string containing valid HTML depending upon what you specified for AFTFORM_ESCAPE_TYPE. or HTML commands that you want to appear at the bottom of the HTML Parameter Form. Values You must specify two items for this attribute:
n AFTFORM_ESCAPE_TYPE can be set to either SRW.SET_AFTER_FORM_HTML procedure. simplified procedure. This attribute is useful for placing a logo or some standard links on the Parameter Form .TEXT_ESCAPE. but it is highly recommended that you use the new. graphics.SET_ATTR is still supported for compatibility. Description Is any text.
6
Report Builder Reference
.

or HTML commands that you want to appear at the end of pages of your document.SET_ATTR is still supported for compatibility.
n The default HTML included at the end of a page is shown below. simplified procedure. If you specify a file.SET_ATTR is still supported for compatibility. the File searching method is used to find it.FILE_ESCAPE or SRW. This attribute is useful for placing a logo or some standard links at the end of each page in an HTML document. simplified procedure. Setting this attribute via SRW.SET_ATTR to set the AFTPAGE_ESCAPE attribute. such as the Before Report trigger.AFTPAGE_ESCAPE
New Feature: It is now more convenient to set this attribute using the SRW.SET_ATTR for this attribute you must use SRW. but it is highly recommended that you use the new. graphics. SRW.
AFTPAGE_ESCAPE restrictions
n When you specify SRW.SET_AFTER_PAGE_HTML procedure.TEXT_ESCAPE. Description Is any text. Values You must specify two items for this attribute:
n AFTPAGE_ESCAPE_TYPE can be set to either SRW. but it is highly recommended that you use the new. Setting this attribute via SRW. n If you want the AFTPAGE_ESCAPE to apply only to the current page.ATTR).REPORT_ID as the object_id:
SRW.
Graphic page separator example
Note: This example illustrates using SRW.REPORT_ID. It is now more convenient to set this attribute using the SRW. you should specify it in a format trigger for an object on that page. */
Report Builder Reference
7
.
/* The example below inserts a GIF file as a ** page separator. n AFTPAGE_ESCAPE_VALUE can be a filename or a text string containing valid HTML depending upon what you specified for AFTPAGE_ESCAPE_TYPE. you should specify it in a trigger that fires before the report begins formatting.SET_AFTER_PAGE_HTML procedure. It is not required unless you want the default separator line to appear between pages.SET_ATTR(SRW.
<hr size=5 noshade>
n If you want the AFTPAGE_ESCAPE to apply to every page of the report.

AFTREPORT_ESCAPE
New Feature: It is now more convenient to set this attribute using the SRW. */ function BeforeReport return boolean is begin if ((upper(:MODE) != ’CHARACTER’) and
Report Builder Reference
9
.SET_ATTR for this attribute you must use SRW.
</body></html>
n AFTREPORT_ESCAPE should be set in a trigger that fires before the report is done formatting.
Links to home pages example
Note: This example illustrates using SRW. Setting this attribute via SRW.TEXT_ESCAPE.SET_ATTR to set the AFTREPORT_ESCAPE attribute. simplified procedure. Setting this attribute via SRW.REPORT_ID.FILE_ESCAPE or SRW. or HTML commands that you want to appear at the end of your document. SRW.
n The default HTML included at the end of a report is shown below. such as the Before Report trigger. but it is highly recommended that you use the new.ATTR).SET_AFTER_REPORT_HTML procedure. If you use AFTREPORT_ESCAPE to replace this text. Values You must specify two items for this attribute:
n AFTREPORT_ESCAPE_TYPE can be set to either SRW. This attribute is useful for placing a logo or some standard links at the end of an HTML document.SET_ATTR(SRW.SET_ATTR is still supported for compatibility.SET_AFTER_REPORT_HTML procedure. simplified procedure. n AFTREPORT_ESCAPE_VALUE can be a filename or a text string containing valid HTML depending upon what you specified for AFTREPORT_ESCAPE_TYPE.SET_ATTR is still supported for compatibility. If you specify a file. you must ensure that it contains the equivalent HTML commands. It is now more convenient to set this attribute using the SRW. graphics. the File searching method is used to find it. but it is highly recommended that you use the new.
AFTREPORT_ESCAPE restrictions
n When you specify SRW.REPORT_ID as the object_id:
SRW.
/* The example below inserts two links to home pages ** at the end of the report output. Description Is any text.

This attribute is ignored in character mode. but it is highly recommended that you use the new. Values A valid color name. Setting this attribute via SRW. simplified procedure.SET_ATTR is still supported for compatibility. Description Is the background border color of the object.BBCOLOR
New Feature: It is now more convenient to set this attribute using the SRW.SET_BACKGROUND_BORDER_COLOR procedure.
Report Builder Reference
11
.

SET_BEFORE_PRINTING_CODE procedure. Setting this attribute via SRW. where number is a number assigned to a packaged Report Builder printer escape sequence or a printer escape sequence that you created. simplified procedure.SET_ATTR is still supported for compatibility. BEFCODE is only used when running your report in character-mode. The printer escape sequence is inserted after the object is triggered to print but before it has actually printed.BEFCODE
New Feature: It is now more convenient to set this attribute using the SRW. Description Is a reference to the printer escape sequence to be executed before each line of the object. but it is highly recommended that you use the new.
12
Report Builder Reference
. Values A string of the form &number.

Values You must specify two items for this attribute:
n BEFFORM_ESCAPE_TYPE can be set to either SRW. the File searching method is used to find it.
Report Builder Reference
13
.BEFFORM_ESCAPE
New Feature: It is now more convenient to set this attribute using the SRW.FILE_ESCAPE or SRW. Setting this attribute via SRW.TEXT_ESCAPE. simplified procedure. This attribute is useful for placing a logo or some standard links on the Parameter Form .SET_ATTR is still supported for compatibility. Description Is any text. If you specify a file.SET_BEFORE_FORM_HTML procedure. graphics. n BEFFORM_ESCAPE_VALUE can be a filename or a text string containing valid HTML depending upon what you specified for BEFFORM_ESCAPE_TYPE. but it is highly recommended that you use the new. or HTML commands that you want to appear at the top of the HTML Parameter Form.

SET_ATTR(SRW.
n If you want the BEFPAGE_ESCAPE to apply to every page of the report. n If you want the BEFPAGE_ESCAPE to apply only to the current page. graphics.FILE_ESCAPE or SRW.ATTR. but it is highly recommended that you use the new.BEFPAGE_ESCAPE_ATTR +
14
Report Builder Reference
.REPORT_ID as the object_id:
SRW.
BEFPAGE_ESCAPE restrictions
n When you specify SRW. you should specify it in a trigger that fires before the report begins formatting. If you specify a file.
Before and after page escape example
Note: This example illustrates using SRW. or HTML commands that you want to appear at the beginning of pages of your document.MASK := SRW.
/* The example below centers the document in ** the browser.SET_BEFORE_PAGE_HTML procedure. SRW. n BEFPAGE_ESCAPE_VALUE can be a filename or a text string containing valid HTML depending upon what you specified for BEFPAGE_ESCAPE_TYPE. Setting this attribute via SRW.SET_ATTR for this attribute you must use SRW. such as the Before Report trigger .SET_BEFORE_PAGE_HTML and SRW.BEFPAGE_ESCAPE
New Feature: It is now more convenient to set this attribute using the SRW. Values You must specify two items for this attribute:
n BEFPAGE_ESCAPE_TYPE can be set to either SRW.ATTR). Description Is any text.SET_ATTR is still supported for compatibility.SET_ATTR is still supported for compatibility. simplified procedure. you should specify it in a format trigger for an object on that page.SET_AFTER_PAGE_HTML procedures.TEXT_ESCAPE. the File searching method is used to find it. Setting this attribute via SRW. This attribute is useful for placing a logo or some standard links at the beginning of each page in an HTML document. It is now more convenient to set these attributes using the SRW. simplified procedure. but it is highly recommended that you use the new.SET_ATTR to set the BEFPAGE_ESCAPE and AFTPAGE_ESCAPE attributes. */ function BeforeReport return boolean is begin if ((upper(:MODE) != ’CHARACTER’) and (upper(:DESFORMAT) = ’HTML’)) then SRW.REPORT_ID.

If you specify a file.ATTR). simplified procedure.REPORT_ID as the object_id:
SRW.SET_ATTR to set the BEFREPORT_ESCAPE and AFTREPORT_ESCAPE attributes. The HTML for AFTREPORT_ESCAPE is specified within the PL/SQL itself. such as the Before Report trigger.htm.SET_ATTR(SRW.REPORT_ID. the File searching method is used to find it. n BEFREPORT_ESCAPE_VALUE can be a filename or a text string containing valid HTML depending upon what you specified for BEFREPORT_ESCAPE_TYPE.
n The default HTML included at the beginning of a report is shown below. If you use BEFREPORT_ESCAPE to replace this text. It is now more convenient to set these attributes using the SRW.SET_ATTR is still supported for compatibility.
Before and after report escape example
Note: This example illustrates using SRW.FILE_ESCAPE or SRW. Setting this attribute via SRW.SET_AFTER_REPORT_HTML procedures. Setting this attribute via SRW. This attribute is useful for placing a logo or some standard links at the beginning of an HTML document.
/* ** ** ** ** */ The example below sets both BEFREPORT_ESCAPE and AFTREPORT_ESCAPE in the Before Report trigger.
BEFREPORT_ESCAPE restrictions
n When you specify SRW. SRW.BEFREPORT_ESCAPE
New Feature: It is now more convenient to set this attribute using the SRW. graphics. Description Is any text. Values You must specify two items for this attribute:
n BEFREPORT_ESCAPE_TYPE can be set to either SRW.SET_ATTR for this attribute you must use SRW.
16
Report Builder Reference
.SET_BEFORE_REPORT_HTML procedure. or HTML commands that you want to appear at the beginning of your document. The HTML for BEFREPORT_ESCAPE is located in a file named logo. simplified procedure. you must ensure that it contains the equivalent HTML commands.SET_BEFORE_REPORT_HTML and SRW.
<html> <body bgcolor="#ffffff">
n BEFREPORT_ESCAPE should be set in a trigger that fires before the report starts formatting.TEXT_ESCAPE. but it is highly recommended that you use the new. but it is highly recommended that you use the new.SET_ATTR is still supported for compatibility.

SET_BACKGROUND_FILL_COLOR procedure. Description Is the background fill color of the object.SET_ATTR is still supported for compatibility.BFCOLOR
New Feature: It is now more convenient to set this attribute using the SRW. This attribute is ignored in character mode. simplified procedure.
18
Report Builder Reference
. Setting this attribute via SRW. but it is highly recommended that you use the new. Values A valid color name.

Values A text string with no indentation/ordering information. For example:
1#Expense Summary Section 2#Expense Detail Section 2.SET_ATTR is still supported for compatibility.3.3.. Description Is a string that will appear in a frame of the master HTML document or in the PDF viewer if you open the bookmark area. Setting this attribute via SRW.g.4#Expenses for the Western Sales Region
BOOKMARK restrictions
n If the same outline number is used multiple times. but it is highly recommended that you use the new. The pound sign (#) and outline number do not appear in the bookmark window but are used to determine order and indentation.. all entries appear but the order is defined by when the objects are rendered by the report.1#Expenses for the Administration Department 2. Clicking on the bookmark displays the associated object at the top of the window.0 followed by 2.3.3. there will be no visible effect (e. simplified procedure.BOOKMARK
New Feature: It is now more convenient to set this attribute using the SRW.SET ATTR to set the BOOKMARK attribute. n BOOKMARK should only be set in the following triggers:
Format
BOOKMARK example
Note: This example illustrates using SRW.1. If the gap is between a higher level number and a lower level number. given there is no 1.3#Expenses for the Sales Department 2.1 and 1.g. where x is an outline number. intermediate levels will be generated as required (e.2#Expenses for the Engineering Department 2.3.2#Expenses for the Northern Sales Region 2. one of two things will happen.3#Expenses for the Southern Sales Region 2. The bookmark will appear in the bookmark list according to when the object is rendered by the report.SET_BOOKMARK
Report Builder Reference
19
.1 entries to be defined. A text string with explicit ordering/indentation of the form x#book_mark_name .3.1#Expenses for the Eastern Sales Region 2.2. 1. will appear next to each other and at the same indentation level). whose titles will be the same as the subsequent real entry). It is now more convenient to set this attribute using the SRW. 1. n If there are gaps in the numbers. If the gap is between peer level numbers.3.SET_BOOKMARK procedure.3.1 will cause dummy 2 and 2.

attr.attr.BOOKMARK_ATTR.BOOKMARK_ATTR. */ function B_2FormatTrigger return boolean is begin srw. end.set_attr(0. Setting this attribute via SRW.attr. 1#) or perhaps a string ** that makes the bookmark unique within the report.set_attr(0.
/* The format trigger below defines a bookmark for ** the boilerplate object B_2.attr).SET_BOOKMARK procedure.procedure.srw.SET_ATTR is still supported for compatibility. Setting this attribute via SRW.g.bookmark := ’1#Expense Summary Section’.srw. In this case.
/* The format trigger below defines a bookmark for ** the boilerplate object B_2. */ function B_2FormatTrigger return boolean is begin srw. srw.
20
Report Builder Reference
. CATEGORY could contain ** ordering information (e. but it is highly recommended that you use the new. return (TRUE).SET ATTR to set the BOOKMARK attribute.attr). simplified procedure.SET_ATTR is still supported for compatibility.bookmark := :category || ’ Expense Summary Section’. ** If you did not want the ordering information. you ** could omit 1#.mask := srw.mask := srw.
Dynamic BOOKMARK example
Note: This example illustrates using SRW. srw. srw. return (TRUE). end. srw. Notice the use of ** explicit ordering information (1#) in this example.attr. It is now more convenient to set this attribute using the SRW. Notice that the name ** of the bookmark is dynamic. but it is highly recommended that you use the new. CATEGORY is a column ** value that is concatenated with the string Expense ** Summary Section for each execution of the format ** trigger.. simplified procedure.

SET_BORDER_WIDTH procedure. but it is highly recommended that you use the new. Values 0 Means no border. Setting this attribute via SRW. Description Is the border width of the object. simplified procedure.SET_ATTR is still supported for compatibility.BORDERWIDTH
New Feature: It is now more convenient to set this attribute using the SRW.
Report Builder Reference
21
. any positive Means a border width of that many picas for a bit-mapped integer report or one character for a character mode report.

Values A valid pattern name.
22
Report Builder Reference
.SET_ATTR is still supported for compatibility.BORDPATT
New Feature: It is now more convenient to set this attribute using the SRW. Description Is the fill pattern for the border of the object. but it is highly recommended that you use the new.SET_BORDER_PATTERN procedure. This attribute is ignored in character mode. Setting this attribute via SRW. simplified procedure.

simplified procedure. Values A valid font name on the machine where the report is run.SET_ATTR is still supported for compatibility.
Report Builder Reference
23
. but it is highly recommended that you use the new. Setting this attribute via SRW. This attribute is ignored in character mode. DATE.FACE
New Feature: It is now more convenient to set this attribute using the SRW. Description Is the font face of a CHAR.SET_FONT_FACE procedure. or NUMBER field.

Values A valid color name. but it is highly recommended that you use the new. Setting this attribute via SRW. This attribute is ignored in character mode. Description Is the foreground border color of the object.SET_FOREGROUND_BORDER_COLOR procedure.FBCOLOR
New Feature: It is now more convenient to set this attribute using the SRW.
24
Report Builder Reference
.SET_ATTR is still supported for compatibility. simplified procedure.

Description Is the foreground fill color of the object.SET_FOREGROUND_FILL_COLOR procedure. Values A valid color name. Setting this attribute via SRW.
Report Builder Reference
25
. but it is highly recommended that you use the new.FFCOLOR
New Feature: It is now more convenient to set this attribute using the SRW. simplified procedure.SET_ATTR is still supported for compatibility. This attribute is ignored in character mode.

SET_ATTR is still supported for compatibility. Description Is the fill pattern of the object. Values A valid pattern name.
26
Report Builder Reference
. but it is highly recommended that you use the new. Setting this attribute via SRW.SET_FILL_PATTERN procedure. This attribute is ignored in character mode.FILLPATT
New Feature: It is now more convenient to set this attribute using the SRW. simplified procedure.

Report Builder Reference
27
. but it is highly recommended that you use the new. Setting this attribute via SRW. Description Is the format mask for the DATE.SET_FORMAT_MASK procedure. or NUMBER field.SET_ATTR is still supported for compatibility. Values Any valid format mask. simplified procedure.FORMATMASK
New Feature: It is now more convenient to set this attribute using the SRW.

or NUMBER field. DATE.SET_ATTR is still supported for compatibility. Setting this attribute via SRW. Values A valid color name. This attribute is ignored in character mode. but it is highly recommended that you use the new.SET_TEXT_COLOR procedure. Description Is the global text color of the CHAR.GCOLOR
New Feature: It is now more convenient to set this attribute using the SRW.
28
Report Builder Reference
. simplified procedure.

gspacing := SRW. but it is highly recommended that you use the new.mask := SRW. If you use srw. or NUMBER field. Values srw. srw.SET_CUSTOM_SPACING or SRW.GSPACING
New Feature: It is now more convenient to set this attribute using the SRW.single_spacing srw. Description Is the global text leading for a CHAR.set_attr (0. DATE.CUSTOM_SPACING. srw.attr. srw.onehlf_spacing srw.custom_spacing Specifies the spacing in VGS units.custom := 200.SET_ATTR is still supported for compatibility.
Report Builder Reference
29
. then you specify the custom number of VGS units using srw.custom.double_spacing srw.GSPACING_ATTR. or boilerplate text.attr.SET_SPACING procedures. srw.attr). This attribute is ignored in character mode. simplified procedures. which are very small.attr. For example:
srw.attr.custom_spacing. Setting this attribute via SRW.

right_hjust srw. or NUMBER field.
30
Report Builder Reference
.SET_ATTR is still supported for compatibility.center_hjust srw.HJUST
New Feature: It is now more convenient to set this attribute using the SRW. simplified procedure. DATE. Setting this attribute via SRW.left_hjust srw. but it is highly recommended that you use the new.flush_hjust Is ignored in bit-mapped reports.SET_JUSTIFICATION procedure. Values srw. Description Is the horizontal justification of the CHAR.

but it is highly recommended that you use the new.g. simplified procedure.com/filetoget.pdf.g.com/newdoc.html..pdf) for the boilerplate object B_2.SET_ATTR is still supported for compatibility. configured as a helper application or installed as a plug-in to your Web browser). the PDF viewer must be configured to work with a Web browser (e.com/cgibin/webmenu?choice1)
HYPERLINK restrictions
n HYPERLINK should only be set in the following triggers: n Format n To follow Web links from a PDF viewer to a remote server or HTML document. http://www.example.pdf#some_dest_name) To any URL (e.HYPERLINK
New Feature: It is now more convenient to set this attribute using the SRW.newmach.pdf#a_dest_name) To a destination within a remote document (e. but it is highly recommended that you use the new.. http://www.newmach. ftp://www.somemch. simplified procedure. Setting this attribute via SRW.mask := srw. Description Is a URL Web link specification. file:/private/somedoc.SET_ATTR is still supported for compatibility..g.newmach.g. */ function B_2FormatTrigger return boolean is begin srw.SET_HYPERLINK procedure..SET_ATTR to set the HYPERLINK attribute.
HYPERLINK example
Note: This example illustrates using SRW. Setting this attribute via SRW.com/newdoc. http://www.g.pdf or file:///C|/temp/mynewdoc.com/newdoc.SET_HYPERLINK procedure..reposit.g. http://www.HYPERLINK_ATTR.com/newdoc. It is now more convenient to set this attribute using the SRW.pdf) To another document on a different machine (e.
Report Builder Reference
31
.. Note: An object that is the source of a Web link cannot also be associated with an action.pdf) To a destination within the current document (e.newmach.attr. file:/private/mynewdoc.. ** you would omit http://www. ** Note: If the target were in the same document.g. #my_dest_name) To a destination within a local document (e. Values A valid link: To another document on the same machine (e.
/* The format trigger below defines a Web link ** to a destination (mytarget) in another document ** (newdoc.

srw.bbcolor := ’green’.FBCOLOR_ATTR + srw.avi. Setting this attribute via SRW. srw.SET_ATTR is still supported for compatibility.80 ) then return (’bad.attr. :docsdir := :web_server || ’/webdemo/docs/’.attr.attr.BBCOLOR_ATTR.attr.attr. ** this function would assign the following Web ** link to the object: ** http://www.set_attr(0.avi’).set_attr(0.mask + srw.SET_ATTR to set the HYPERLINK attribute.
32
Report Builder Reference
. ** For example. srw. if the value of SRCDIR were ** http://www.com/newdoc. srw.attr. return (TRUE).pdf’ || ’#mytarget’. It is now more convenient to set this attribute using the SRW. simplified procedure. srw.newmach. if ( upper(:cf_pickvideo) like ’%GOOD%’ ) then srw. end if.SET_HYPERLINK procedure.attr). but it is highly recommended that you use the new. end if. end.HYPERLINK_ATTR.com and CF_PICKVIDEO were good. /* SRCDIR is a parameter whose value is determined at ** runtime by the following After Parameter Form trigger */ function AfterPForm return boolean is begin :srcdir := :web_server || ’/webdemo/src/’.avi.attr).
Dynamic HYPERLINK example
Note: This example illustrates using SRW.fbcolor := ’green’.com/webdemo/src/good. end. /* CF_PICKVIDEO is a formula column whose value is ** determined by the following function */ function CF_pickvideoFormula return Char is begin if ( :avg_h_div < . Notice how the ** destination of the link is determined dynamically ** based upon the values of SRCDIR and CF_PICKVIDEO. else return (’good.
/* The format trigger below defines a Web link ** for the boilerplate object B_3. end.avi’).newmach.attr. return (TRUE). */ function B_3FormatTrigger return boolean is begin srw.srw.mask := srw.hyperlink := ’http://www.newmach.hyperlink := :srcdir||:cf_pickvideo. return (TRUE).mask := srw.srw. end. srw.

but it is highly recommended that you use the new. It is now more convenient to set this attribute using the SRW.SET_LINKTAG procedure. simplified procedure. Setting this attribute via SRW.SET_ATTR is still supported for compatibility. Values A valid.SET_ATTR is still supported for compatibility.LINKTAG_ATTR. Description Is an object’s identifier and can be used as the destination in Web links.SET_ATTR to set the LINKTAG attribute. Setting this attribute via SRW.ATTR). return (TRUE). unique name that only makes use of the 26 upper or lower case US ASCII letters. simplified procedure.mask := SRW.
Dynamic LINKTAG example
Note: This example illustrates using SRW.
/* The format trigger below assigns an identifier ** (mytarget) to the boilerplate object B_500. Setting this attribute via SRW. It is now more convenient to set this attribute using the SRW.linktag := ’mytarget’.
/* ** ** ** ** */ The format trigger below assigns an identifier to the field F_Dept by concatenating some static text (dept_details_) with the value of the source column (DEPTNO). numbers.SET_ATTR to set the LINKTAG attribute. srw.
Report Builder Reference
33
.attr. end. ** This means that the object can now be the destination ** of a Web link.set_attr(0.SET_LINKTAG procedure. simplified procedure. This function ensures that a unique identifier is assigned to each instance of F_Dept.SET_ATTR is still supported for compatibility.
LINKTAG restrictions
n LINKTAG should only be set in the following triggers:
Format
LINKTAG example
Note: This example illustrates using SRW. or underscore characters.attr. */ function B_500FormatTrigger return boolean is begin srw. srw.LINKTAG
New Feature: It is now more convenient to set this attribute using the SRW. but it is highly recommended that you use the new. but it is highly recommended that you use the new. Other special characters will automatically be converted to underscore characters.SET_LINKTAG procedure. SRW.

attr). return (TRUE). end.SET_ATTR to set the PRINTER_INTRAY attribute. Values A valid.PRINTER_INTRAY
New Feature: It is now more convenient to set this attribute using the SRW. but it is highly recommended that you use the new.SET_ATTR is still supported for compatibility.
PRINTER_INTRAY restrictions
n PRINTER_INTRAY should only be set in the following triggers:
Between Pages Before Report Format
PRINTER_INTRAY example
Note: This example illustrates using SRW. Setting this attribute via SRW.mask := SRW.SET_ATTR is still supported for compatibility. simplified procedure. unique name as defined for your printer in the Page Setup dialog. srw. srw. Description Is the name of a valid printer tray and can be used switch to different printer trays as your report formats.printer_intray := ’letterhead’.
Report Builder Reference
35
. srw.
/* The example below sets the printer tray in the Between Pages trigger. but it is highly recommended that you use the new. Setting this attribute via SRW.SET_PRINTER_TRAY procedure. simplified procedure.PRINTER_INTRAY_ATTR.set_attr(SRW.REPORT_ID.attr. It is now more convenient to set this attribute using the SRW. */ function BetweenPages return boolean is begin srw.SET_PRINTER_TRAY procedure.attr.

outline_style srw.STYLE
New Feature: It is now more convenient to set this attribute using the SRW. DATE. Setting this attribute via SRW.overstrike_style srw. but it is highly recommended that you use the new.blink_style
36
Report Builder Reference
. or NUMBER field.inverted_style srw.italic_style srw. Values srw.underline_style srw.SET_ATTR is still supported for compatibility. simplified procedure. Description Is the font style of the CHAR.oblique_style srw.SET_FONT_STYLE procedure. This attribute is ignored in bit-mapped reports.shadow_style srw.plain_style srw.

Report Builder Reference
37
.SET_FONT_SIZE procedure. DATE. simplified procedure. This attribute is ignored in character mode. or NUMBER field. Values A valid size for the named font on the machine where the report will run. but it is highly recommended that you use the new.SET_ATTR is still supported for compatibility. Description Is the font size of the CHAR. Setting this attribute via SRW.SZ
New Feature: It is now more convenient to set this attribute using the SRW.

Values srw.SET_ATTR is still supported for compatibility.underlinebold_texta srw.reverse_texta srw.underlinereverse_texta srw.SET_CHARMODE_TEXT procedure.reverseboldunderline_texta
38
Report Builder Reference
. simplified procedure. or NUMBER field.TEXT
New Feature: It is now more convenient to set this attribute using the SRW.bold_texta srw.reversebold_texta srw. This attribute is ignored in bit-mapped reports. Description Is the character mode text characteristic for the CHAR.plain_texta srw. DATE.underline_texta srw. but it is highly recommended that you use the new. Setting this attribute via SRW.

or NUMBER field.medium_weight srw. but it is highly recommended that you use the new. This attribute is ignored in character mode.WEIGHT
New Feature: It is now more convenient to set this attribute using the SRW.light_weight srw. Description Is the font weight of the CHAR. Setting this attribute via SRW.SET_FONT_WEIGHT procedure.SET_ATTR is still supported for compatibility. Values srw.bold_weight srw.extralight_weight srw. DATE. simplified procedure.demibold_weight srw.ultralight_weight srw.extrabold_weight
Report Builder Reference
39
.demilight_weight srw.

e. Note: You cannot reference constructs in the SRW package from another product.. Report Builder is shipped with a package --i.The Report Builder PL/SQL package (SRW)
To save you time. i. for example. from SQL*Plus. and exceptions you can reference in any of your libraries or reports. and packaged exceptions. Constructs found in a package are commonly referred to as "packaged". packaged procedures. packaged functions. a collection of PL/SQL constructs--that contains many functions.. procedures.e. SRW. As a result.
40
Report Builder Reference
.g. any time you reference a construct in the SRW package.DO_SQL. The name of Report Builder’s package is SRW. e. you must prefix it with SRW..

use the SRW.add_definition (:xml_col).ADD_DEFINITION multiple times to get your entire report definition into the buffer. you can use SRW.SRW. For example:
srw.ADD_DEFINITION(:column_name | variable). You may need to execute SRW.xml’).
Usage Notes • To apply the XML report definition.apply_definition.
Report Builder Reference
41
.
•
If the XML report definition is located in a file.apply_definition(’d:\xml_reps\web. you can use SRW.APPLY_DEFINITION built-in.ADD_DEFINITION
Description This procedure takes an XML report definition stored in a column or variable and adds it to the document buffer. Once the definition is in the buffer. For example:
srw. Syntax
SRW.APPLY_DEFINITION to apply it. srw.APPLY_DEFINITION by itself to reference the file.

APPLY_DEFINITION takes no arguments.xml)].APPLY_DEFINITION
Description This procedure takes an XML report definition stored in the document buffer or file system and applies it to the report. If applying a definition from the document buffer.APPLY_DEFINITION takes the name and path of the file as an argument. For example:
srw.APPLY_DEFINITION statements in the order that you want them to be applied. simply stack separate SRW. If the XML report definition is located in a file.add_definition (:xml_col).APPLY_DEFINITION[(filename. SRW.
42
Report Builder Reference
. SRW. you can use SRW. Syntax
SRW.
•
•
To apply an XML report definition from the document buffer you must first use SRW.APPLY_DEFINITION by itself to reference the file.
Usage Notes • If you want to apply more than one XML report definition. If applying a definition from a file.apply_definition(’d:\xml_reps\web.apply_definition.SRW.xml’).ADD_DEFINITION to place the definition in the buffer. For example:
srw. srw.

SRW. because data for the report is not fetched until the Before Report trigger (which fires after the After Form trigger). Report execution resumes when the read-only screen is accepted.BREAK.BREAK was encountered. Syntax
SRW.BREAK
Description This procedure temporarily stops report execution at the place at which SRW. n All column and parameter values are displayed in the read-only screen. No PL/SQL variables.BREAK restrictions
n This procedure is not meaningful in a Before Form or After Form trigger.
Report Builder Reference
43
. or any other object values are displayed.
SRW. and displays (read-only) the current values of all columns and parameters.

** instead of the default error message. Name Parameter Data Format Report Form Model Trigger Trigger srw.user_exit YES YES YES YES
SRW.CONTEXT_FAILURE
Description This exception stops the report execution and raises the following error message: REP-1426: Running <construct_name> from incorrect context.message YES YES YES YES srw.’).set_field_date NO NO YES NO srw.reference YES YES YES YES srw.CONTEXT_FAILURE.break NO YES YES NO srw.do_sql YES YES YES YES srw. ’Contact the Application Development group regarding SRW. raise srw. NO means that the function or procedure cannot be called in that context.
44
Report Builder Reference
.set_field_num NO NO YES NO srw.
Usage Notes Report Builder raises this exception when a Report Builder packaged function or procedure is called in the wrong context (see the chart below). In this chart.program_abort.CONTEXT_FAILURE.set_attr NO NO YES NO srw.set_maxrow NO YES YES YES srw. Syntax
SRW.SRW.CONTEXT_FAILURE example
/* Suppose you want your own error message raised.message(4000.get_page_num NO NO YES NO srw.geterr_run YES YES YES YES srw.CONTEXT_FAILURE then srw. ** You could handle this exception in the following way: */ EXCEPTION when SRW. YES means it can.set_field_char NO NO YES NO srw.run_report YES YES YES YES srw.

For example. then you should use 2000 as the width for the parameter. you should ensure that the parameter is wide enough to contain the selected values.DO_SQL
Description This procedure executes the specified SQL statement from within Report Builder.DO_SQL. see the ORACLE8 Server SQL Language Reference Manual.DO_SQL statement below: The destination parameter (my_ename) needs a width that is equal to the maximum width of the ENAME column. n A bind variable’s value can be at most 64. Remember to precede any Report Builder object names with a colon (:). or DML (statements that manipulate data). you will get a truncation exception. DML statements are usually faster when they are in PL/SQL. it will be truncated to the left-most 64. instead of via a user exit.000 bytes.DO_SQL example
/* ** ** ** ** Suppose you want your report to create a table named CHECK just before the Runtime Parameter Form is displayed.DO_SQL restrictions
n In Report trigger order of execution.
srw. If the parameter is not large enough. the SRW.DO_SQL. Syntax
SRW. The reason for this is that the selected value contains trailing spaces up to the assumed size of the value. The SQL statement can be DDL (statements that define data). Because CREATE TABLE is a SQL DDL statement (and PL/SQL cannot perform DDL statements). If you are not sure about the maximum width of the SELECT list item. your PL/SQL could look like this in the Before Form
Report Builder Reference
45
. notice where the SET TRANSACTION READONLY occurs.DO_SQL (sql_statement CHAR).do_sql(’SELECT ENAME INTO :my_ename FROM EMP’).
SRW. instead of in SRW. For more information on DDL or DML statements. you need to use SRW.SRW. (When the value exceeds that limit. Therefore. Since you cannot perform DDL statements in PL/SQL.DO_SQL packaged procedure is especially useful for performing them within Report Builder.) n If you use a parameter as the destination of a character column for an INTO clause.
Parameters sql_statement
Is any valid SQL statement.000 bytes. suppose that you have the SRW.
SRW.

MESSAGE(2. Otherwise. RAISE SRW. RETURN(TRUE). SORT_CHAR CHAR(1). ’REPORT WAS STOPPED BEFORE THE RUNTIME PARAMETER FORM.DO_SQL(’CREATE TABLE CHECK (EMPNO NUMBER NOT NULL PRIMARY KEY. and page number on which its ** field fires to print.PROGRAM_ABORT. */ FUNCTION CREATETAB RETURN BOOLEAN IS BEGIN SRW. Assume that you want to put the "table of contents" ** into a table named SHIP. SRW. EXCEPTION WHEN SRW. SRW.MESSAGE(100. SAL NUMBER (10. Report Builder would not be able to parse your query. SRW.2)) PCTFREE 5 PCTUSED 75’).GET_PAGE_NUM(PAGE_NO).’||TO_CHAR(PAGE_NO)||’)’. CMD_LINE := ’INSERT INTO SHIP VALUES (’’’||SORT_CHAR||’’’. /* Suppose you want to create a "table of contents" by getting the ** first character of a column’s value. END IF.MESSAGE(2.DO_SQL_FAILURE THEN SRW.MESSAGE(50. You could write the following construct: */ DECLARE PAGE_NO NUMBER.USER_EXIT(’RWECOP PAGE_FOR_INDEX P_START_PAGENO’).trigger: */ /* Additional Information: If you use a table created in this way for your ** report output. END. SRW. BEGIN SORT_CHAR := :SORT_NAME .TO_CHAR(:P_START_PAGENO)).GET_PAGE_NUM(PAGE_FOR_INDEX). the table must exist before you create your query in the ** data model. SRW.’). ’ERROR WHILE CREATING CHECK TABLE.’). IF :CALLED = ’Y’ THEN SRW.CMD_LINE). CMD_LINE CHAR(200). SRW.DO_SQL(CMD_LINE).
46
Report Builder Reference
. PAGE_FOR INDEX NUMBER.

DO_SQL_FAILURE THEN SRW. WHEN OTHERS THEN COMMIT. END.’FAILED TO INSERT ROW INTO SHIP TABLE’). WHEN SRW. EXCEPTION WHEN DUP_VAL_ON_INDEX THEN NULL.MESSAGE(1.
Report Builder Reference
47
.COMMIT.

SRW. Syntax
SRW.DO_SQL_FAILURE
Description This exception stops the report execution and raises the following error message:
REP-1425: Error running DO_SQL package . ** instead of the default error message. yet tries to create a table with SRW.g.message(1000. ORA-msg Is an optional ORACLE message.DO_SQL). if the user does not have DDL privileges. ’Error occurred while creating table CHECKS.REP-msg ORA-msg
where: REP-msg Is a Report Builder message..
SRW.DO_SQL_FAILURE example
/* Suppose you want your own error message raised.DO_SQL packaged procedure fails (e. providing more information on the Report Builder message. ** You could handle this exception in the following way: */ EXCEPTION when SRW.DO_SQL_FAILURE.
48
Report Builder Reference
.
Usage Notes Report Builder raises this exception when the SRW.’).DO_SQL_FAILURE then srw.

e. When you specify SRW..g.FILE_ESCAPE
Indicates that the HTML is located in a file.FILE_ESCAPE.xxxx_ESCAPE_VALUE (where xxxx is the name of the escape. you should enter a filename for SRW. BEFREPORT).
Report Builder Reference
49
.SRW.

Report Builder Reference
51
. page_num + 3).GET_PAGE_NUM restrictions
n SRW. END. This is useful when you want to use the page number in the field’s Format Trigger property.set_field_num (0. end. Returns The current page number. ** In the field’s Format Trigger. srw.GET_PAGE_NUM example
/* Suppose you want to perform a computation based upon a page number.GET_PAGE_NUM is only meaningful in a format trigger.SRW.
SRW. page_num
SRW.GET_PAGE_NUM function: */ BEGIN DECLARE PAGE_NUM NUMBER.
Parameters Is the variable in which you want to place the current page number. It has no effect when entered in other places. begin srw.get_page_num (page_num). Syntax
SRW.GET_PAGE_NUM
Description This function returns the current page number. you could use SRW.GET_PAGE_NUM (page_num).

g.xxxx_ESCAPE_VALUE.xxxx_ESCAPE_VALUE (where xxxx is the name of the escape. When you specify SRW..TEXT_ESCAPE
Indicates that the HTML is specified in SRW.TEXT_ESCAPE. you should enter a quoted string for SRW.
52
Report Builder Reference
. e.SRW. BEFREPORT).

SRW. or HTML commands that you want to appear at the bottom of the HTML Parameter Form. Is a filename or the text to be inserted depending on what was specified for the type parameter.SET_AFTER_FORM_HTML(SRW. This attribute is useful for placing a logo or some standard links on the Parameter Form.oracle. */ function BeforeForm return boolean is begin if ((upper(:MODE) != ’CHARACTER’) and (upper(:DESFORMAT) = ’HTML’)) then SRW.’string’). It indicates whether the string parameter is a filename or the text to be inserted.
Parameters type Is SRW.SET_AFTER_FORM_HTML(type.SET_AFTER_FORM_HTML example
/* This example inserts two links to home pages ** at the bottom of the HTML Parameter Form.TEXT_ESCAPE.
string
Property Palette To define this attribute using the Property Palette.SRW. end. Syntax
SRW.
54
Report Builder Reference
. graphics. set the After Form Type and After Form Value properties.’<CENTER>’ || ’<A HREF="http://www.com/">’ || ’Netscape</A> </CENTER>’ || ’</BODY> </HTML>’).netscape.TEXT_ESCAPE.SET_AFTER_FORM_HTML
Description This procedure inserts any text.FILE_ESCAPE or SRW.com/">’ || ’Oracle Corporation</A> -’ || ’chr(10)’ || ’<A HREF="http://home. return (TRUE). end if.

SET_AFTER_PAGE_HTML(SRW. n If you want SRW.SET_AFTER_PAGE_HTML(type. respectively.
SRW. Syntax
SRW. */ function BeforeReport return boolean is begin if ((upper(:MODE) != ’CHARACTER’) and (upper(:DESFORMAT) = ’HTML’)) then SRW. you should specify it in a trigger that fires before the report begins formatting.FILE_ESCAPE or SRW. Property Palette To define this attribute using the Property Palette.SET_AFTER_PAGE_HTML
Description This procedure inserts any text.SET_AFTER_PAGE_HTML to apply to every page of the report.’<CENTER>’ ||
Report Builder Reference
55
. depending on what you specified for the type parameter.SET_BEFORE_REPORT_HTML or SRW.SET_AFTER_PAGE_HTML example
/* The example below inserts a GIF file as a ** page separator. To specify HTML for only the first (header) or last (footer) pages of your report.’string’).
<hr size=5 noshade>
n If you want SRW. This attribute is useful for placing a logo or some standard links at the end of each page in an HTML document.
Parameters Is SRW. It is not required unless you want the default separator line to appear between pages. type
SRW. use the SRW. you should specify it in a format trigger for an object on that page.TEXT_ESCAPE.TEXT_ESCAPE. this procedure applies to all pages of your report output. string Is a filename or the text to be inserted. such as the Before Report trigger.SRW. graphics. set the After Page Type and After Page Value properties.SET_AFTER_REPORT_HTML PL/SQL procedures. If you use HTML page streaming. It indicates whether the string parameter is a filename or the text to be inserted. or HTML commands that you want to appear at the end of pages of your document.SET_AFTER_PAGE_HTML restrictions
n The default HTML included at the end of a page is shown below.SET_AFTER_PAGE_HTML to apply only to the current page.

Parameters code Is a valid printer code that is defined in the .SET_AFTER_PRINTING_CODE(’code’). Printer codes are only used when running your report in character-mode.
Property Palette To define this attribute using the Property Palette. set the Printer Code After property.prt file specified for DESFORMAT.
Report Builder Reference
57
.SET_AFTER_PRINTING_CODE
Description This procedure inserts a reference to the printer escape sequence to be executed after each line of the object. The printer escape sequence is inserted after the object is triggered to print but before it has actually printed. Syntax
SRW.SRW.

</body></html>
n SRW.
SRW. such as the Before Report trigger. Syntax
SRW. Is a filename or the text to be inserted. To specify HTML to apply to the entire report (e.SET_AFTER_REPORT_HTML to replace this text.SET_AFTER_REPORT_HTML(type.SET_AFTER_REPORT_HTML
Description This procedure inserts any text.
Parameters type Is SRW. This attribute is useful for placing a logo or some standard links at the end of an HTML document. */ function BeforeReport return boolean is begin if ((upper(:MODE) != ’CHARACTER’) and (upper(:DESFORMAT) = ’HTML’)) then SRW.SET_BEFORE_PAGE_HTML PL/SQL procedure.SET_AFTER_REPORT_HTML restrictions
n The default HTML included at the end of a report is shown below. graphics.g.
string
Property Palette To define this attribute using the Property Palette.SET_AFTER_REPORT_HTML example
/* The example below inserts two links to home pages ** at the end of the report output.FILE_ESCAPE or SRW.SRW. If you use SRW.’string’). you must ensure that it contains the equivalent HTML commands. background color or images.oracle.
SRW. you must use the SRW.SET_AFTER_REPORT_HTML should be set in a trigger that fires before the report is done formatting.com/">’ || ’Oracle Corporation</A> -’ ||
58
Report Builder Reference
. set the After Report Type and After Report Value properties.SET_AFTER_REPORT_HTML(SRW.’<CENTER>’ || ’<A HREF="http://www. If you use HTML page streaming. or HTML commands that you want to appear at the end of your document.TEXT_ESCAPE. or any other <body> HTML attributes). It indicates whether the string parameter is a filename or the text to be inserted..TEXT_ESCAPE. this procedure applies to the first page of your report output. depending on what you specified for the type parameter.

set the Edge Background Color property.SRW. Only the foreground color shows through in this case. refer to Changing colors .
Parameters color Usage Notes Is a valid color from the color palette. the background color does not show through the pattern.SET_BACKGROUND_BORDER_COLOR
Description This procedure specifies the background border color of the object. User Interface To set the background border color in the user interface. if the pattern is solid.
Property Palette (Templates only) To define this attribute for templates using the Property Palette. you may not see the background color. the border foreground color is the only one visible on Windows.
60
Report Builder Reference
. Depending upon the pattern being used. As a result. This attribute is ignored in character mode. Syntax
SRW. For example.
n This procedure does not apply to Windows platforms because they do not support a border pattern.SET_BACKGROUND_BORDER_COLOR(’color’).

This attribute is ignored in character mode. set the Background Color property.SET_BACKGROUND_FILL_COLOR(’color’). you may not see the background color. For example.
Property Palette (Templates only) To define this attribute for templates using the Property Palette. Syntax
SRW. Only the foreground color shows through in this case. User Interface To set the background fill color in the user interface. refer to Changing colors .SRW.SET_BACKGROUND_FILL_COLOR
Description This procedure specifies the background fill color of the object. Depending upon the pattern being used. if the pattern is solid.
Parameters color Is a valid color from the color palette. the background color does not show through the pattern.
Report Builder Reference
61
.

depending on what you specified for the type parameter.
62
Report Builder Reference
. Helvetica”>' || '<FONT COLOR="#FF0000">' || 'Click <IMG SRC=”RUN. It indicates whether the string parameter is a filename or the text to be inserted.SET_BEFORE_FORM_HTML example
/* The example below sets both the before and after ** form escapes in the Before Form trigger.FILE_ESCAPE or SRW.htm’).TEXT_ESCAPE. graphics. Syntax
SRW. set the Before Form Type and Before Form Value properties. */ function BeforeForm return boolean is begin if ((upper(:MODE) != ’CHARACTER’) and (upper(:DESFORMAT) = ’HTML’)) then SRW. ** The HTML for the before escape is located in a file ** named logo.SET_BEFORE_FORM_HTML(type. <B> || '<FONT FACE-“Arial.TEXT_ESCAPE.’string’).SET_BEFORE_FORM_HTML(SRW.SRW.
SRW.htm.GIF” HEIGHT=18 WIDTH=18>' || 'to run the report using the parameters you have' || 'specified above.SET_BEFORE_FORM_HTML
Description This procedure inserts any text.
string
Property Palette To define this attribute using the Property Palette. The HTML for the after report escape ** is specified within the PL/SQL itself.FILE_ESCAPE. or HTML commands that you want to appear at the top of the HTML Parameter Form.’logo. ' || '</FONT></FONT></B>'). end if. return (TRUE). Is a filename or the text to be inserted.
Parameters type Is SRW. SRW.SET_AFTER_FORM_HTML(SRW. end. This attribute is useful for placing a logo or some standard links on the Parameter Form .

Syntax
SRW. you should specify it in a format trigger for an object on that page.. or any other <body> HTML attributes).g. To specify HTML for only the first (header) or last (footer) pages of your report.TEXT_ESCAPE. or HTML commands that you want to appear at the beginning of pages of your document. It indicates whether the string parameter is a filename or the text to be inserted.
SRW. SRW. n If you want the SRW.TEXT_ESCAPE.SET_BEFORE_PAGE_HTML(type. this procedure applies to all pages of your report output (e.SET_BEFORE_PAGE_HTML to apply to every page of the report. you should specify it in a trigger that fires before the report begins formatting.SET_BEFORE_PAGE_HTML restrictions
n If you want the SRW.FILE_ESCAPE or SRW.SET_BEFORE_PAGE_HTML
Description This procedure inserts any text.SET_AFTER_PAGE_HTML(SRW.SRW.
SRW.
Parameters type Is SRW. such as the Before Report trigger . use the SRW.
Report Builder Reference
63
.TEXT_ESCAPE.SET_BEFORE_PAGE_HTML example
/* The example below centers the document in ** the browser.SET_BEFORE_PAGE_HTML(SRW. depending on what you specified for the type parameter. If you use HTML page streaming.
string
Property Palette To define this attribute using the Property Palette.’<CENTER>’). This attribute is useful for placing a logo or some standard links at the beginning of each page in an HTML document.’string’). respectively. set the Before Page Type and Before Page Value properties.’</CENTER>’). */ function BeforeReport return boolean is begin if ((upper(:MODE) != ’CHARACTER’) and (upper(:DESFORMAT) = ’HTML’)) then SRW.SET_BEFORE_REPORT_HTML or SRW. Is a filename or the text to be inserted.SET_BEFORE_PAGE_HTML to apply only to the current page. background color or images. graphics.SET_AFTER_REPORT_HTML PL/SQL procedures.

64
Report Builder Reference
. return (TRUE).end if. end.

The printer escape sequence is inserted after the object is triggered to print but before it has actually printed.SET_BEFORE_PRINTING_CODE
Description This procedures inserts a reference to the printer escape sequence to be executed before each line of the object. Syntax
SRW. Printer codes are only used when running your report in character-mode.SET_BEFORE_PRINTING_CODE(’code’).
Property Palette To define this attribute using the Property Palette.
Report Builder Reference
65
.
Parameters code Is a valid printer code that is defined in the .prt file specified for DESFORMAT. set the Printer Code Before property.SRW.

SET_BEFORE_REPORT_HTML(type.TEXT_ESCAPE. or any other <body> HTML attributes). ** The HTML for the before escape is located in a file ** named logo.
SRW.htm.g.SET_BEFORE_REPORT_HTML example
/* The example below sets both the before and after ** report escapes in the Before Report trigger.
string
Property Palette To define this attribute using the Property Palette. */ function BeforeReport return boolean is begin if ((upper(:MODE) != ’CHARACTER’) and
66
Report Builder Reference
. you must ensure that it contains the equivalent HTML commands. To specify HTML to apply to the entire report (e. If you use SRW.SRW.SET_BEFORE_REPORT_HTML
Description This procedure inserts any text. graphics.
SRW.SET_BEFORE_REPORT_HTML to replace this text.SET_BEFORE_PAGE_HTML PL/SQL procedure. depending on what you specified for the type parameter. background color or images.
Parameters type Is SRW. Is a filename or the text to be inserted. It indicates whether the string parameter is a filename or the text to be inserted. Syntax
SRW. this procedure applies to the first page of your report output. you must use the SRW. The HTML for the after report escape ** is specified within the PL/SQL itself.FILE_ESCAPE or SRW.SET_BEFORE_REPORT_HTML should be set in a trigger that fires before the report starts formatting.. such as the Before Report trigger. If you use HTML page streaming. set the Before Report Type and Before Report Value properties. or HTML commands that you want to appear at the beginning of your document.’string’). This attribute is useful for placing a logo or some standard links at the beginning of an HTML document.
<html> <body bgcolor="#ffffff">
n SRW.SET_BEFORE_REPORT_HTML restrictions
n The default HTML included at the beginning of a report is shown below.

If you open the bookmark area and click on the bookmark. the object appears at the top of the window.4#Expenses for the Western Sales Region
Property Palette To define this attribute using the Property Palette. Syntax
SRW.3.SET_BOOKMARK
Description This procedure associates a bookmark with the object and specifies a string that will appear in a bookmark frame of the master HTML document or the PDF document. n A text string with explicit ordering/indentation of the form x#book_mark_name .SRW.SET_BOOKMARK restrictions
n If the same outline number is used multiple times. For example:
1#Expense Summary Section 2#Expense Detail Section 2.3#Expenses for the Southern Sales Region 2.
Parameters bookmark Is one of the following:
n A text string with no indentation/ordering information.SET_BOOKMARK(’bookmark’).3.
SRW. The bookmark will appear in the bookmark list according to when the object is rendered by the report.1#Expenses for the Eastern Sales Region 2. set the Bookmark property.2#Expenses for the Northern Sales Region 2.1#Expenses for the Administration Department 2.3.3#Expenses for the Sales Department 2.2#Expenses for the Engineering Department 2.3. where x is an outline number. all entries appear but the order is
68
Report Builder Reference
. The pound sign (#) and outline number do not appear in the bookmark window but are used to determine order and indentation.

1 and 1.3.SET_BOOKMARK example
/* The format trigger below defines a bookmark for ** the boilerplate object B_2.2. there will be no visible effect (e.SET_BOOKMARK example
/* The format trigger below defines a bookmark for ** the boilerplate object B_2.g.defined by when the objects are rendered by the report.
Report Builder Reference
69
. you ** could omit 1#. */ function B_2FormatTrigger return boolean is begin srw.1. intermediate levels will be generated as required (e. given there is no 1. n SRW. one of two things will happen.. If the gap is between peer level numbers. */ function B_2FormatTrigger return boolean is begin srw.SET_BOOKMARK should only be set in the following triggers: n Format
SRW.3.set_bookmark(’1#Expense Summary Section’). return (TRUE). In this case. CATEGORY is a column ** value that is concatenated with the string Expense ** Summary Section for each execution of the format ** trigger.set_bookmark(:category || ’ Expense Summary Section’)..1 entries to be defined. end. CATEGORY could contain ** ordering information (e. 1#) or perhaps a string ** that makes the bookmark unique within the report. return (TRUE).
Dynamic SRW. Notice that the name ** of the bookmark is dynamic. end. will appear next to each other and at the same indentation level). 1. 1. Notice the use of ** explicit ordering information (1#) in this example. If the gap is between a higher level number and a lower level number.
n If there are gaps in the numbers.3. ** If you did not want the ordering information.g.1 will cause dummy 2 and 2. whose titles will be the same as the subsequent real entry).3.g..0 followed by 2.

70
Report Builder Reference
.g. refer to Changing object border attributes .SRW. Syntax
SRW.
Parameters pattern Usage Notes Is the fill pattern for the border (e. This attribute is ignored in character mode.
n This procedure does not apply to Windows platforms because they do not support a border pattern.
Property Palette (Templates only) To define this attribute for templates using the Property Palette.SET_BORDER_PATTERN(’pattern’). set the Edge Pattern property.. solid). User Interface To set the border attributes in the user interface.SET_BORDER_PATTERN
Description This procedure specifies the fill pattern for the border of the object.

Zero indicates no border and a positive integer indicates the width of the border in picas.SRW. refer to Changing object border attributes . User Interface To set the border attributes in the user interface. Syntax
SRW. width
Report Builder Reference
71
.
Parameters Is zero or any positive integer.SET_BORDER_WIDTH
Description This procedure specifies the width of the object’s border in picas.SET_BORDER_WIDTH(width).

DATE.
Parameters style Is one of the following:
SRW.BOLD_TEXTA SRW. or NUMBER field.
72
Report Builder Reference
. refer to Changing text attributes .SET_CHARMODE_TEXT
Description This procedure specifies the font style of a CHAR. Syntax
SRW.SRW.PLAIN_TEXTA User Interface To set the font attributes in the user interface.REVERSE_TEXTA SRW.REVERSEBOLDUNDERLINE_TEXT A SRW. This attribute is ignored in bit-mapped reports.REVERSEBOLD_TEXTA SRW.UNDERLINE_TEXTA SRW.UNDERLINEREVERSE_TEXTA SRW.SET_CHARMODE_TEXT(’style’).

SET_CUSTOM_SPACING
Description This procedure specifies the global text leading for a CHAR. This attribute is ignored in character mode. Syntax
SRW.SRW. or NUMBER field.SET_CUSTOM_SPACING(spacing).
Report Builder Reference
73
. DATE. or boilerplate text. which are very small.
Parameters spacing Is a number that represents the leading in VGS units.

Parameters text_string
Is any text string that only makes use of the 26 upper or lower case US ASCII letters. Other special characters will automatically be converted to underscore characters.SET_DISPLAY_NAME
Description This procedure specifies text that displays in a popup as the cursor moves over an image object in reports output in HTML or HTMLCSS format.SET_DISPLAY_NAME example
/* The format trigger below assigns a text string ** (’Click here to fill your shopping basket’) to the image ** object BASKET. Property Palette To define this attribute using the Property Palette.SRW. or underscore characters.SET_DISPLAY_NAME restrictions
n SRW.SET_DISPLAY_NAME should only be set in the following triggers: n Format
SRW.SET_DISPLAY NAME(’text_string’). Syntax
SRW.SET_DISPLAY_NAME(’Click here to fill your shopping basket’). set the Display Name property. numbers. In the HTML report. end. */ function BASKETFormatTrigger return boolean is begin SRW. this popup will display ** when the cursor moves over the BASKET object. return (TRUE).
SRW.
74
Report Builder Reference
.

srw. you can use the quotes if you also use the TO_NUMBER function. text CHAR|number NUM|date DATE). BEGIN if :sal >= 2000 then tmp := :sal * 1. tmp).
SRW.set_field(0. to_date(’01-JAN-99’)). Alternatively. For example:
srw. 99). the value is assumed to be a character string. (The object must always set its own attributes.
Parameters object_id text number date Usage Notes Is always 0. This is useful when you want to conditionally change a field’s value. you could type the following:
FUNCTION CHGFIELD RETURN BOOLEAN IS TMP NUMBER.SET_FIELD Example
/* ** ** ** */ Suppose you want to conditionally change the number of a field. In the format trigger for the field. to_number(’99’)). For example:
srw.
n If you use quotes without a function. number. the value is assumed to be a number.SET_FIELD
Description This procedure sets the value of a character. or date field.08. Syntax
SRW. based on each employee’s salary.set_field(0. to_char(’my string’)).
n For date values.set_field (0. For example:
srw.) Is the character. or date string you want the field to display.set_field(0. you need to convert the second argument to a date value with the TO_DATE function.SET_FIELD (object_id.set_field(0. you can use the TO_CHAR function for consistency with number and date values:
srw.
n If you omit quotes around the value.
Alternatively.
Report Builder Reference
75
. number.SRW.

set_field_char (0.
Parameters object_id text Is always 0. based on each employee’s salary. ’HIGH SALARY’). RETURN (TRUE). text CHAR).) Is the character string you want the field to display. (The object must always set its own attributes. This is useful when you want to conditionally change a field’s character value. end if. ** In the format trigger for the field.SET_FIELD_CHAR example
/* Suppose you want to conditionally change the value of a ** Character field. It has no affect when entered in other places.SET_FIELD_CHAR restrictions
n SRW. Syntax
SRW.SET_FIELD_CHAR is only meaningful in the format trigger of a field of Datatype Character. you could type the following: */ FUNCTION CHGFIELD RETURN BOOLEAN IS BEGIN if :sal >= 2000000 then srw.SET_FIELD_CHAR (object_id. END.
SRW.
Report Builder Reference
77
.SET_FIELD_CHAR
Description This procedure sets the value of a character field.SRW.
SRW.

RETURN (TRUE).SET_FIELD_DATE (object_id.SET_FIELD_DATE example
/* Suppose you want to conditionally change the date of the reunion ** invitation. based on each student’s graduation year.) Is the date you want the field to display. (The object must always set its own attributes. In the format ** trigger for the field. else end if.SET_FIELD_DATE
Description This procedure sets the value of a date field. Syntax
SRW.set_field_date (0. It has no affect when entered in other places.SRW.SET_FIELD_DATE is only meaningful in a format trigger for a date field. date DATE). This is useful when you want to conditionally change a field’s date value. you could type the following: */ FUNCTION CHGFIELD RETURN BOOLEAN IS BEGIN if :graduation >= 1975 then srw. ’02-JUL-95’).
78
Report Builder Reference
. END.
SRW.
SRW.
Parameters: object_id date Is always 0.SET_FIELD_DATE restrictions
n SRW.

It has no affect when entered in other places. BEGIN if :sal >= 2000 then tmp := :sal * 1.SET_FIELD_NUM (object_id. number NUM).
SRW.
Report Builder Reference
79
. end if.) Is the number you want the field to display.
SRW. you could type the following: */ FUNCTION CHGFIELD RETURN BOOLEAN IS TMP NUMBER. Syntax
SRW. srw. ** based on each employee’s salary.08. END.set_field_num (0. else srw.
Parameters object_id number Is always 0. tmp). RETURN (TRUE).set_field_num (0.SET_FIELD_NUM
Description This procedure sets the value of a number field.SRW.SET_FIELD_NUM is only meaningful in the format trigger of a field of Datatype NUMBER.SET_FIELD_NUM example
/* Suppose you want to conditionally change the number of a field.SET_FIELD_NUM restrictions
n SRW. (The object must always set its own attributes. ’2500’). This is useful when you want to conditionally change a field’s number value. In the format trigger for the ** field.

refer to Changing patterns.SET_FILL_PATTERN(’pattern’).SET_FILL_PATTERN
Description This procedure specifies the fill pattern of the object.g. Syntax
SRW. This attribute is ignored in character mode.SRW.
Property Palette (Templates only) To define this attribute for templates using the Property Palette.
Parameters pattern Is the fill pattern for the object (e.
80
Report Builder Reference
. set the Fill Pattern property.. User Interface To set the border attributes in the user interface. solid).

SRW.
Report Builder Reference
81
. or NUMBER field. e. arial.. refer to Changing text attributes .SET_FONT_FACE(’face’).SET_FONT_FACE
Description This procedure specifies font face for a CHAR. User Interface To set the font attributes in the user interface. Syntax
SRW.
Parameters face Is the font face.
Property Palette (Templates only) To define this attribute for templates using the Property Palette. This attribute is ignored in character mode. set the Font property. DATE.g.

g. User Interface To set the font attributes in the user interface.
82
Report Builder Reference
. e.SET_FONT_SIZE
Description This procedure specifies font size for a CHAR. Syntax
SRW.
Parameters size Is the font size. set the Font property. or NUMBER field. 9 (point).
Property Palette (Templates only) To define this attribute for templates using the Property Palette.. DATE. refer to Changing text attributes .SRW.SET_FONT_SIZE(size). This attribute is ignored in character mode.

DATE. refer to Changing text attributes .ITALIC_STYLE).OUTLINE_STYLE SRW.PLAIN_STYLE Usage Notes
n If you use this procedure multiple times on the same field.
Parameters style Is one of the following: SRW.OBLIQUE_STYLE SRW. Property Palette (Templates only) To define this attribute for templates using the Property Palette.BLINK_STYLE SRW.SET_FONT_STYLE(SRW. use the PLAIN style.SRW.SET_FONT_STYLE(style). For example. Syntax
SRW. the font styles will accumulate.SET_FONT_STYLE(SRW. This attribute is ignored in character mode.ITALIC_STYLE SRW. User Interface To set the font attributes in the user interface. or NUMBER field.UNDERLINE_STYLE).INVERTED_STYLE SRW. set the Font property.
To negate all of the accumulated styles.SET_FONT_STYLE
Description This procedure specifies font style for a CHAR. the following would cause the field to be underlined and italic:
SRW.SHADOW_STYLE SRW.UNDERLINE_STYLE SRW. SRW.
Report Builder Reference
83
.

BOLD_WEIGHT SRW. set the Font property. This attribute is ignored in character mode.LIGHT_WEIGHT SRW.EXTRALIGHT_WEIGHT SRW.SET_FONT_WEIGHT
Description This procedure specifies font weight for a CHAR. Syntax
SRW.
Parameters weight Is one of the following: SRW.MEDIUM_WEIGHT Property Palette (Templates only) To define this attribute for templates using the Property Palette. User Interface To set the font attributes in the user interface.DEMIBOLD_WEIGHT SRW.EXTRABOLD_WEIGHT SRW. refer to Changing text attributes .
84
Report Builder Reference
.DEMILIGHT_WEIGHT SRW.ULTRALIGHT_WEIGHT SRW. DATE.SRW.SET_FONT_WEIGHT(weight). or NUMBER field.

Parameters color Is a valid color from the color palette. User Interface To set the foreground border color in the user interface. Syntax
SRW.SET_FOREGROUND_BORDER_COLOR
Description This procedure specifies the foreground border color of the object. This attribute is ignored in character mode.SRW. refer to Changing colors . set the Edge Foreground Color property.
Property Palette (Templates only) To define this attribute for templates using the Property Palette.SET_FOREGROUND_BORDER_COLOR(’color’).
Report Builder Reference
85
.

Syntax
SRW.
Parameters color Is a valid color from the color palette. User Interface To set the foreground fill color in the user interface.SET_FOREGROUND_FILL_COLOR(’color’).SET_FOREGROUND_FILL_COLOR
Description This procedure specifies the foreground fill color of the object.
86
Report Builder Reference
.
Property Palette (Templates only) To define this attribute for templates using the Property Palette. refer to Changing colors . This attribute is ignored in character mode.SRW. set the Foreground Color property.

Parameters mask Is a valid format mask.
Report Builder Reference
87
.SET_FORMAT_MASK(’mask’). See Date Format Mask Syntax or Number Format Mask Syntax
Property Palette To define this attribute using the Property Palette.SET_FORMAT_MASK
Description This procedure specifies the format mask for the DATE or NUMBER field.SRW. Syntax
SRW. set the Format Mask property.

.g. #my_dest_name) n To a destination within a local document (e..pdf#a_dest_name) n To a destination within a remote document (e.g.somemch...SET_HYPERLINK(’hyperlink’).pdf) n To another document on a different machine (e.com/newdoc.g.com/filetoget. file:/private/somedoc.com/newdoc. the PDF viewer must be configured to work with a Web browser (e..newmach. http://www.SET_HYPERLINK should only be set in the following triggers: n format n To follow Web links from a PDF viewer to a remote server or HTML document.newmach.com/newdoc.
SRW.g.pdf or file:///C|/temp/mynewdoc.g..pdf#some_dest_ name) n To any URL (e. set the Hyperlink property. Syntax
SRW. http://www.example.SET_HYPERLINK restrictions
n SRW. http://www..g.pdf) n To a destination within the current document (e.SRW.com/cgibin/webmenu?choice1)
Property Palette To define this attribute using the Property Palette. Note: An object that is the source of a Web link cannot also be associated with an action. http://www.g.SET_HYPERLINK
Description This procedure specifies a URL Web link specification.
88
Report Builder Reference
.newmach.
Parameters hyperlink
Is a valid link:
n To another document on the same machine (e. file:/private/mynewdoc. ftp://www.html.reposit. configured as a helper application or installed as a plug-in to your Web browser).

80 ) then return (’bad. if ( upper(:cf_pickvideo) like ’%GOOD%’ ) then SRW.
Report Builder Reference
89
. return (TRUE).newmach. /* CF_PICKVIDEO is a formula column whose value is ** determined by the following function */ function CF_pickvideoFormula return Char is
begin if ( :avg_h_div < . return (TRUE).avi.pdf) for the boilerplate object B_2.SET_HYPERLINK example
/* The format trigger below defines a Web link ** for the boilerplate object B_3. SRW.avi’).SET_HYPERLINK example
/* The format trigger below defines a Web link ** to a destination (mytarget) in another document ** (newdoc. */ function B_2FormatTrigger return boolean is begin SRW. ** Note: If the target were in the same document. end if.com/webdemo/src/good. ** this function would assign the following Web ** link to the object: ** http://www. end. end.newmach.SET_BACKGROUND_BORDER_COLOR(’green’).com/newdoc. /* SRCDIR is a parameter whose value is determined at ** runtime by the following After Parameter Form trigger */ function AfterPForm return boolean is begin :srcdir := :web_server || ’/webdemo/src/’.newmach.SET_HYPERLINK(:srcdir||:cf_pickvideo). end.SET_HYPERLINK(’http://www.SET_FOREGROUND_BORDER_COLOR(’green’).avi. :docsdir := :web_server || ’/webdemo/docs/’. Notice how the ** destination of the link is determined dynamically ** based upon the values of SRCDIR and CF_PICKVIDEO. else return (’good. return (TRUE). ** For example.com/newdoc.SRW.pdf.
Dynamic SRW.newmach. */ function B_3FormatTrigger return boolean is begin SRW.avi’). if the value of SRCDIR were ** http://www.com and CF_PICKVIDEO were good.pdf’ || ’#mytarget’). ** you would omit http://www.

end.end if.
90
Report Builder Reference
.

SRW.status=’Click here to see what is in your shopping basket’.SET_HYPERLINK_ATTRS restrictions
n SRW. end.
SRW.SET_HYPERLINK_ATTRS example
/* The format trigger below generates a status ** of information at the bottom of your Web browser ** when the mouse cursor passes over a Shopping Basket ** object. set the Additional Hyperlink Attributes property.SET_HYPERLINK_ATTRS should only be set in the following triggers: n format
SRW.
Report Builder Reference
91
.
Parameters HTML_string Is a string containing the HTML commands to be applied.SET HYPERLINK procedure. return (TRUE). */ function BASKETFormatTrigger return boolean is begin SRW.SET_HYPERLINK_ATTRS(’string’).status=’ ’.SET_HYPERLINK_ATTRS
Description This procedure applies additional HTML commands to the hyperlink specified in the Property Palette or SRW.return true"’). Syntax
SRW. Property Palette To define this attribute using the Property Palette.return true" onMouseout ="window.SET_HYPERLINK_ATTRS(’onMouseover "window.

Property Palette (Templates only) To define this attribute in templates using the Property Palette. Date Justification property for date fields. refer to Changing text attributes .CENTER_HJUST.SET_JUSTIFICATION
Description This procedure specifies the horizontal justification of the CHAR.LEFT_HJUST SRW.
Parameters justification
Is one of the following: SRW. User Interface To set the horizontal justification in the user interface. Number Justification property for number fields.SET_JUSTIFICATION(justification). or NUMBER field.
92
Report Builder Reference
. set the Character Justification property for character fields.RIGHT_HJUST SRW. Syntax
SRW.FLUSH_HJUST SRW. DATE.SRW.

Parameters linktag
A valid.SET_LINKTAG
Description This procedure specifies an object’s identifier and can be used as the destination in Web links. or underscore characters. */ function F_DeptFormatTrigger return boolean is begin SRW.
Dynamic SRW. Syntax
SRW.SET_LINKTAG(’mytarget’). set the Hyperlink Destination property. end.SET_LINKTAG example
/* The format trigger below assigns an identifier to ** the field F_Dept by concatenating some static text ** (dept_details_) with the value of the source column ** (DEPTNO).SET_LINKTAG(’linktag’). ** This means that the object can now be the destination ** of a Web link. Other special characters will automatically be converted to underscore characters. unique name that only makes use of the 26 upper or lower case US ASCII letters.
Report Builder Reference
93
.
Property Palette To define this attribute using the Property Palette. */ function B_500FormatTrigger return boolean is begin SRW.SET_LINKTAG restrictions
n SRW.SET_LINKTAG should only be set in the following triggers: n format
SRW. end. return (TRUE). SRW. This function ensures that a unique ** identifier is assigned to each instance of F_Dept.SET_LINKTAG example
/* The format trigger below assigns an identifier ** (mytarget) to the boilerplate object B_500.SET_LINKTAG(’dept_details_’ || LTRIM(TO_CHAR(:deptno))).SRW. numbers. return (TRUE).

that you have a user-created parameter.SET_MAXROW is only meaningful in a Before Report trigger (i.SET_MAXROW is called after the Before Report trigger (i. Q_Stocks and Q_Bonds. Suppose also. Syntax
SRW. maxnum PLS_INTEGER).e. In the Before Report trigger. you could use the SRW. Is maximum number of records you want the query to fetch. etc. after the queries have been executed). after the query is parsed).
SRW.SET_MAXROW (query_name CHAR. displays) fewer records than the query (or queries) that fetch them..
Property Palette To define this attribute using the Property Palette. enabling you to improve the report’s performance. 0).SET_MAXROW examples
/* ** ** ** ** ** */ Suppose your report has two queries.SET_MAXROW procedure to ensure that only one query’s data is fetched:
FUNCTION FETCHIT RETURN BOOLEAN IS BEGIN if :whichdata != 1 then srw.e.e. that enables users to specify which data they want the report to display: either stocks or bonds.
Parameters query_name maxnum Is the query whose fetched records will be limited.MAXROW_UNSET packaged exception is raised.
SRW. n Because this procedure causes only the specified number of records to be fetched. set the Maximum Rows to Fetch property. named WHICHDATA. else
94
Report Builder Reference
. the "unfetched" records of the query are not used in computations. with SRW. you can conditionally restrict data that is fetched for your report.SET_MAXROW restrictions
n SRW.set_maxrow (’Q_Stocks’.SET_MAXROW
Description This procedure sets the maximum number of records to be fetched for the specified query. n If you specify that 0 records should be fetched. This is useful when your report formats (i. Thus.SET_MAXROW..SRW. the query will still be parsed.. the SRW. If SRW.

myreport)..
96
Report Builder Reference
. If left blank.
Report Builder assigns values to these variables during formatting. If you want to use icons and images in this frame.
Parameters type Is SRW. depending on what was specified for the type parameter. It indicates whether the string parameter is a filename or the HTML script text to be inserted.TEXT_ESCAPE. string Is a filename or the HTML scripting code to be inserted.FILE_ESCAPE or SRW. the default Report Builder JavaScript is used to define navigation controls on each page of report output.g. Syntax
SRW. e. keep these dimensions in mind.SRW. The width of the frame is variable.’string’). set the Page Navigation Control Type and Page Navigation Control Value properties. The height of the page navigation control frame is hard coded to 70 points without a scroll bar. Usage Notes If you choose to provide your own script for navigation controls. Property Palette To define this attribute using the Property Palette.SET_PAGE_NAVIGATION_HTML(type.SET_PAGE_NAVIGATION_HTML
Description This procedure specifies the scripting for navigation controls in pagestreamed HTML/HTMLCSS report output. you must include two variables in your script:
n n
&TotalPages (total number of pages) &file_name (the name of the output destination file.

. Note: An object that is associated with an action cannot also be the source of a Web link.SRW.g.
Property Palette To define this attribute using the Property Palette.
Report Builder Reference
97
.
SRW.rdf when the ** button object U_Report is clicked ** in the PDF viewer.SET_PDF_ACTION is only available for PDF output.SET_PDF_ACTION
Description This procedure specifies a command line that will be executed on the local machine when the object is clicked in the PDF viewer.SET_PDF_ACTION restrictions
n SRW. Syntax
SRW.rdf or /usr/local/bin/phone smith). c:\orawin\bin\rwrun60 userid=scott/tiger report=example. end. */ function U_ReportFormatTrigger return boolean is begin SRW.
Parameters action
Is any valid command line on the local machine (e. n SRW.SET_PDF_ACTION should only be set in the following triggers:
Format
SRW. set the Application Command Line (PDF) property.SET_PDF_ACTION(’action’).rdf’).SET_PDF_ACTION example
/* The format trigger below runs a ** report named example.SET_PDF_ACTION || (’c:\orawin\bin\rwrun60’ || ’userid=scott/tiger ’ || ’report=example.

Parameters tray Usage Notes
Is the name of a valid printer tray and can be used to switch to different printer trays as your report formats.SET_PRINTER_TRAY(’tray’).SET_PRINTER_TRAY example
/* The example below sets the printer ** tray in a Between Pages trigger. */ function BetweenPages return boolean is begin SRW.SET_PRINTER_TRAY
Description This procedure specifies the name of a valid printer tray and can be used to switch to different printer trays as your report formats.SRW. The printer tray you specify remains in effect until you change it in a subsequent trigger.
SRW.SET_PRINTER_TRAY(’letterhead’).
n If you use SRW.
98
Report Builder Reference
. end. return (TRUE).SET_PRINTER_TRAY restrictions
n SRW. Syntax
SRW. you will get an error for incorrect context.SET_PRINTER_TRAY should only be set in the following triggers:
After Report trigger Before Report Between Pages Format If you use SRW.SET_PRINTER_TRAY in the Before or After Form triggers. the printer tray will be changed on the page where the object is printed.SET_PRINTER_TRAY in the Format Trigger of an object.
SRW.

ONEHLF_SPACING
Report Builder Reference
99
.SET_SPACING(spacing). or NUMBER field.SET_SPACING
Description This procedure specifies the global text leading for a CHAR. or boilerplate text. This attribute is ignored in character mode.SRW.
Parameters spacing Is one of the following: SRW. Syntax
SRW.SINGLE_SPACING SRW.DOUBLE_SPACING SRW. DATE.

refer to Changing colors. set the Text Color property. This attribute is ignored in character mode.
100
Report Builder Reference
. DATE. Syntax
SRW. or NUMBER field.SET_TEXT_COLOR(’color’).SRW. User Interface To set the text color in the user interface.SET_TEXT_COLOR
Description This procedure specifies the global text color of the CHAR.
Parameters color Is a valid color from the color palette. Property Palette (Templates only) To define this attribute in templates using the Property Palette.

Syntax:
SRW. raise srw.MESSAGE or SRW.SET_MAXROW is called with a non-integer as a result of an internal error.INTEGER_ERROR then srw.SET_MAXROW>. ’Contact the Application Development group regarding SRW.MESSAGE or SRW.message(4000.SRW.program_abort. PL/SQL will catch the type mismatch via the PL/SQL exception VALUE_ERROR. (If an internal error is not present.
Report Builder Reference
101
.
Usage Notes Report Builder raises this exception when SRW.’). ** instead of the default error message.INTEGER_ERROR
Description This exception stops the report execution and raises the following error message:
REP-1417: Invalid integer argument passed to <SRW.)
SRW.INTEGER_ERROR.INTEGER_ERROR example
/* Suppose you want your own error message raised. ** You could handle this exception in the following way: */ EXCEPTION when SRW.INTEGER_ERROR.

** You could handle this exception in the following way: */ EXCEPTION when SRW. ’Contact Oracle’’s customer support: SRW.
SRW.MAXROW_INERR
Description This exception stops the report execution and raises the following error message:
REP-1424: Internal error while executing SRW.PROGRAM_ABORT to end the report’s execution (because the report has an internal problem).
Usage Notes Report Builder raises this exception when it detects an internal error while executing the SRW. you should contact Oracle Customer Support.MAXROW_INERR’).
/* Suppose you want your own error message raised.SRW.
If it is raised. you should always raise SRW.SET_MAXROW packaged procedure.MAXROW_INERR.MAXROW_INERR example
102
Report Builder Reference
.
SRW. raise srw.message(1000.MAXROW_INERR then srw.MAXROW_INERR.MAXROW_INERR restrictions
• When you handle SRW. ** instead of the default error message. Syntax
SRW.program_abort.SET_MAXROW.

** instead of the default error message.SET_MAXROW packaged procedure is called after the query’s records have already been fetched.
Usage Notes Report Builder raises this exception when the SRW.SET_MAXROW was called.MAXROW_UNSET
Description This exception temporarily stops the report execution and raises the error message below.
SRW.SRW. the report execution will continue.
Report Builder Reference
103
. After the message is raised and you accept it. ’Data was fetched before SRW.MAXROW_UNSET then srw.message(1000.
Syntax
SRW.MAXROW_UNSET example
/* Suppose you want your own error message raised.MAXROW_UNSET. ** You could handle this exception in the following way: */ EXCEPTION when SRW.
REP-1423: Cannot set maximum rows of the query after it started executing.’).

it will be displayed as SRW-00123. Numbers less than five digits will be padded with zeros out to five digits.MESSAGE (msg_number NUMBER. Is at most 190 minus the msg_number alphanumeric characters to be displayed on the message line.
FUNCTION FOO RETURN BOOLEAN IS BEGIN
104
Report Builder Reference
. because it is not linked.PROGRAM_ABORT. Any extra spaces in the message string will be displayed in the message. that you want to raise your own error if the user exit is not found (e. the report execution will continue. to be displayed on the message line. if you want to terminate a report after raising a message. Call Karen Smith x3455.
MSG-msg_number: msg_text.g.
SRW. Suppose. use SRW.MESSAGE examples
/* ** ** ** ** */ /* ** */ Suppose you have a user exit named MYEXIT to which you want to pass the values of the SAL column. extra spaces are not removed by Report Builder.MESSAGE does not terminate the report execution.MESSAGE
Description This procedure displays a message with the message number and text that you specify.).MESSAGE restrictions
n n n
You cannot trap nor change Report Builder error messages. etc. After the message is raised and you accept it.SRW. For example. you could write the following PL/SQL in the Format Trigger of the F_SAL field: This trigger will raise your message as follows: MSG-1000: User exit MYEXIT failed. compiled.
Syntax
SRW.
msg_text
SRW. The message is displayed in the format below. if you specify 123.
Parameters msg_number Is a number from one to ten digits.. msg_text CHAR). SRW. To do these things. also.

USER_EXIT>.SRW. The following could raise this exception:
n SRW. This exception is useful when you pass argument values to a packaged function or procedure.’). ’Contact Application Development regarding SRW. and you want to ensure that the values passed are not NULL (e.NULL_ARGUMENTS
Description This exception stops the report execution and raises the following error message:
REP-1418: Passed null arguments to <SRW. ** instead of the default error message.MESSAGE n SRW..SET_MAXROW n SRW.NULL_ARGUMENTS example
/* Suppose you want your own error message raised.
106
Report Builder Reference
.SET_MAXROW or SRW. and the user exit string is passed from a PL/SQL library).NULL_ARGUMENTS then srw.NULL_ARGUMENTS. when a formula column calls SRW.RUN_REPORT n SRW. ** You could handle this exception in the following way: */ EXCEPTION when SRW.USER_EXIT.DO_SQL n SRW.program_abort.
Usage Notes Report Builder raises this exception when one of its packaged functions or procedures is called with a missing argument.g.
Syntax
SRW. raise srw.NULL_ARGUMENTS.DO_SQL or SRW.USER_EXIT
SRW.MESSAGE or SRW.message(4000.RUN_REPORT or SRW.

mask := SRW. that if the report fetches a salary less than 0. end if.attr.SRW.PROGRAM_ABORT examples
/* Suppose you want to put a border around the salary if it is greater than 0.PROGRAM_ABORT
Description This exception stops the report execution and raises the following error message:
REP-1419: PL/SQL program aborted. To do so. "FOUND A NEGATIVE SALARY.
SRW.
SRW. ** Suppose. srw. CHECK THE EMP TABLE. . also.attr.program_abort.PROGRAM_ABORT stops report execution when you raise it. END. RETURN (TRUE).message(100. srw.e. */ FUNCTION foo return boolean is BEGIN if :sal >= 0 then srw.
Report Builder Reference
107
.PROGRAM_ABORT. ** then terminate the report execution.attr).’)."). srw.BORDERWIDTH_ATTR.borderwidth := 1. Syntax
SRW. you could write the ** following format trigger for F_SAL.
Usage Notes You must raise the exception from within your PL/SQL.set_attr (0. else srw. ’FOUND A NEGATIVE SALARY. . you want to ** raise a customized error message (i.. raise srw.

Is machine off?’). you could write the following formula:
FUNCTION EXIT RETURN BOOLEAN IS BEGIN if :temp > 0 then srw. Suppose. -.user_exit(’superheat temp pressure’). To do so. END. you want to raise a customized error message. ’Temperature is below normal.SRW.reference (:temp).REFERENCE restrictions
n The colon is required before the object name. This causes Report Builder to determine the object’s value just before firing the PL/SQL construct. also. else srw.
Parameters object Is the Report Builder parameter or column whose value needs to be ascertained before the construct fires. Syntax
SRW.reference (:pressure).
SRW. RETURN(TRUE). n SRW.unnecessary reference srw. end if.
SRW.
108
Report Builder Reference
.REFERENCE is unnecessary when the object is already referenced in the current PL/SQL construct. This is useful when you want to ensure that a column value passed to a user exit is the most recently computed or fetched value.message(1000. raise srw.REFERENCE (:object CHAR|DATE|NUMBER).program_abort.REFERENCE
Description This procedure causes Report Builder to add the referenced object to the PL/SQL construct’s dependency list. srw. that if the temperature is too low.REFERENCE example
/* ** ** ** */ Suppose you want to pass the temperature and pressure values to a user exit called SUPERHEAT.

Sysout. calling a report from a button’s action trigger) n sending parts of a report to different recipients (e.e.RUN_REPORT restrictions
n If you want parameter values that are entered on the Runtime Parameter Form to be passed in the RWRUN60 string. the Runtime Parameter Form will not appear by default when the button is selected. Report Builder will use its file path search order to find the report..RUN_REPORT is used in the PL/SQL for a button.. Printer. n No userid should be specified for the SRW. or Mail.RUN_REPORT executes the specified RWRUN60 command. This procedure is useful for:
n running drill-down reports (i.RUN_REPORT.RUN_REPORT after the before form trigger.
Report Builder Reference
109
.
SRW. or Mail. The userid is inherited by the "calling" report. If you want the Runtime Parameter Form to appear. you must specify PARAMFORM=YES in the call to SRW. then DESTYPE can only be File. n If you do not specify a path. n If the parent report that invokes SRW. you must call SRW.RUN_REPORT (command_line CHAR). n If SRW.
Parameters command_line
Is a valid RWRUN60 command. Otherwise. n The string that is specified for or passed to this procedure must follow the syntax and case-sensitivity rules for your operating system. to send a report via e-mail to each manager with just his or her group’s data) n sending parts of a report to different printers (e. DESTYPE can be File.g.g. Printer.RUN_REPORT
Description This procedure invokes RWRUN60 with the string that you specify.SRW.RUN_REPORT is run in batch. Syntax
SRW.RUN_REPORT procedure.. to send each manager’s report to his or her printer) n running multiple reports from a single "driver" report
SRW.

SRW. ** The description of MGR_RUN could be as follows: ** Query: SELECT ENAME. SAL FROM EMP WHERE MGR=:MGR_NO Layout: Master/Detail
/* ** ** ** ** ** ** ** ** ** ** ** */
/* Suppose that you have three reports that you almost always run together. you create a driver report named PAYROLL. ** The description of PAYROLL could be as follows: ** Query: SELECT DEPTNO FROM DEPT ** Before Report Trigger: */
110
Report Builder Reference
.run_report(’report=MAIL_IT desname=’||:ename ||’ desformat=dflt batch=yes mgr_no=’|| TO_CHAR(:empno) ). and passes the manager number. then passes it to a second report. ** The reports are named SALARY. and invokes a second report named MAIL_IT ** MAIL_IT. and TAXES. EMPNO FROM EMP WHERE JOB=’MANAGER’ ** Group Filter: */ FUNCTION FOO RETURN BOOLEAN IS BEGIN srw. so that the MAIL_IT report can query only the manager’s employees.’).RUN_REPORT requires a character string. The description of MAIL_IT could be as follows: Query: SELECT DEPTNO. This PL/SQL invokes MAIL_IT. EXCEPTION when srw. END.run_report_failure then srw. ** and sends the report output to the manager via e-mail.program_abort. To run these reports ** with one RWRUN60 command. COMMISS. Note: EMPNO’s values must be converted to characters (TO_CHAR in the PL/SQL above). ENAME. because this report only fetches data. because SRW. Layout: None is needed.message(30. RETURN (TRUE). which queries employee names for the manager that MGR_RUN passes it.RUN_REPORT example
/* Suppose you have the following two reports: ** MGR_RUN. specifies that MAIL_IT’s output should be sent to the manager via Oracle Mail. raise srw. ’Error mailing reports. which queries manager names.

run_report(’batch=yes report=TAXES destype=file desformat=dflt desname=comiss. the query and the layout for Payroll could be anything. in this case. the other three reports will all be run./* ** ** ** ** */
FUNCTION FOO RETURN BOOLEAN IS BEGIN srw.lis’).lis’). END. RETURN (TRUE).lis’). (Note that.run_report(’batch=yes report=SALARY destype=file desformat=dflt desname=salary.)
Report Builder Reference
111
.run_report(’batch=yes report=COMMISS destype=file desformat=dflt desname=comiss. srw. srw. They are only used here in order to make it possible to run PAYROLL. Layout: Tabular When you run PAYROLL from the designer or RWRUN60.

Syntax
SRW.RUN_REPORT procedure is called with a command line string containing BATCH=NO. raise srw.RUN_REPORT_BATCHNO
Description This exception stops the report execution and raises the following error message:
REP-1429: SRW.RUN_REPORT cannot be invoked with batch=no.RUN_REPORT_BATCHNO.RUN_REPORT_BATCHNO example
/* Suppose you want your own error message raised.
112
Report Builder Reference
.RUN_REPORT_BATCHNO.SRW.’).program_abort. ’Contact Application Dev.
SRW.RUN_REPORT_BATCHNO then srw.
Usage Notes Report Builder raises this exception when the SRW. ** instead of the default error message (above). ** You could handle this exception in the following way: */ EXCEPTION when SRW. Services regarding SRW.message(4000.

Specify a value for each of the attributes that you specified in the previous step (e.SET_ATTR applies attribute settings such as font.SET_ATTR
New Feature: It is now more convenient to set attributes using the Set Attributes Procedures.ATTR. To define HTML document and page headers and footers. If you require more complex implementation.]. . it is 0.] SRW.MASK := SRW..ATTR.attr := value. [SRW. When setting the value of BEFREPORT_ESCAPE. but it is highly recommended that you use the simplified procedures.g. BORDERWIDTH).. the border) by setting SRW. AFTREPORT_ESCAPE attributes. use the ACTION. and LINKTAG attributes. . and AFTPAGE_ESCAPE it is SRW. SRW. use the BEFPAGE_ESCAPE.ATTR).g.SET_ATTR procedure...attr := value.SET_ATTR is still supported for compatibility. Is a valid value for the attribute (e. In all other cases.attr_ATTR [+ SRW.SET_ATTR in three steps:
1
Specify the attributes you wish to set (e.
SRW. Apply the mask to the object by calling the SRW.ATTR. BEFPAGE_ESCAPE. .. use the BEFFORM_ESCAPE and AFTFORM_ESCAPE. size. To define HTML Parameter Form headers and footers. width of 1 character). HYPERLINK. such as conditional settings. or color to layout objects.SET_ATTR:
n n
To specify Web links.
n
Syntax
Parameters attr object_id
value
Is the name of the attribute that you are setting (e. SRW.g. you must use SRW. SRW. BEFREPORT_ESCAPE.MASK. AFTPAGE_ESCAPE.SET_ATTR (object_id. Description SRW. Is 0 or SRW.
2
3
Note: In most cases.
114
Report Builder Reference
.g.ATTR.REPORT_ID. BOOKMARK. AFTREPORT_ESCAPE. 1 would be a a valid value for BORDERWIDTH). You specify formatting attributes with SRW.SRW. . you can define Web links (HTML or PDF) and HTML attributes in an object’s Property Palette.attr_ATTR.REPORT_ID.

FORMATMASK_ATTR + SRW.AFTCODE_ATTR + SRW.ATTR.SET_ATTR character mode example
/* ** ** ** ** ** ** ** */ Here’s an example of using all of the formatting attributes valid for character-mode reports. SRW. n If you specify a value that is not provided by the Report Builder package.FILLPATT_ATTR + SRW. If you do not specify a value for a specified attribute.ATTR.ATTR. SRW. SRW.SRW.ATTR.BEFCODE_ATTR SRW.ATTR.BORDERWIDTH := 1.BOLD_TEXTA. SRW.HJUST must not be enclosed by single quotes. enclosed by single quotes).CENTER_HJUST + SRW.g. you must specify a value for it.HJUST := SRW.SET_ATTR restrictions
n If you specify an attribute (e. To change the text attributes of boilerplate text. SRW. the printer definition file for this report must define what the printer should do for &1 and &2. you will get unpredictable results for that attribute.BORDERWIDTH_ATTR + SRW. because you must specify one of the values that Report Builder provides. a value for SRW.
SRW.SET_ATTR. Notice that there are two values applied to the horizontal justification attribute (HJUST).
+
Report Builder Reference
115
.FLUSH_HJUST.ATTR.
function F_SALFormatTrigger return boolean is begin IF :SAL > 2000 THEN SRW. SRW. END IF.ATTR.e. SRW.MASK := SRW.FORMATMASK must be enclosed by single quotes. A value for SRW. because you may specify any value.AFTCODE := ’&2’.FILLPATT_ATTR). For example.ATTR.TEXT_ATTR + SRW.FORMATMASK := ’DD-MON-YY’..BEFCODE := ’&1’. They cannot be applied to boilerplate text. n Attributes for text can only be applied to fields via SRW. Note: For the printer codes &1 and &2 to be meaningful. use the Format menu or the tool palette in the Layout editor. SRW.FILLPATT := ’TRANSPARENT’. it must be a string (i.ATTR..ATTR.TEXT := SRW.HJUST_ATTR.

SRW.TRACE_START. The following example specifies three tracing options for the mask and then invoking the mask in a call to SRW.TRACE_ERR + SRW. SRW.TRACE_APPEND and SRW. Note that SRW.TRACE_ADD_OPTION enables you to specify a new trace option after you have begun logging trace information with SRW.TRACE_ADD_OPTION:
SRW.TRACEOPTS.TRACEOPTS.MASK := SRW.TRACEOPTS).MASK.TRACEOPTS).TRACE_BRK + SRW.TRACE_ADD_OPTION(SRW.TRACE_REPLACE are not trace options and are not available for use with SRW.
Syntax
SRW.TRACE_ADD_OPTION (SRW.TRACE_PRF.
Parameters SRW.
Report Builder Reference
119
.TRACEOPT Applies the trace options mask previously S defined by SRW.TRACE_ADD_OPTION.TRACE_ADD_OPTION
Description SRW.

Report Builder Reference
121
.TRACEOPTS.
Syntax
SRW.TRACE_BRK + SRW.SRW.MASK. Note that SRWTRACE_APPEND and SRWTRACE_REPLACE are not trace options and are not available for use with SRW.TRACEOPTS.TRACE_REM_OPTION
Description SRW.TRACEOPTS).TRACE_ERR + SRW.MASK := SRW.TRACEOPTS
Removes the trace options in the mask previously defined by SRW.TRACEOPTS).TRACE_PRF.TRACE_REM_OPTION.TRACE_REM_OPTION removes trace options.TRACE_REM_OPTION(SRW. SRW. The following example specifies three tracing options for the mask and then invoking the mask in a call to SRW.
Parameters SRW.TRACE_REM_OPTION (SRW.TRACE_REM_OPTION:
SRW.

SRW.TRACE_START enables you to start logging tracing information to a file during report execution.
SRW.].TRACE_PRF.TRACEOPTS).TRACE_BRK + SRW.TRACE_START
Description SRW. Applies the trace options mask previously defined by SRW.TRACE_opts [+ SRW. SRW. use SRW.TRACE_START (filename. Adds the new information to the end of the file.{SRW. Is a valid tracing option.TRACE_APPEND. To set tracing options in PL/SQL.TRACEOPTS.TRACEOPTS. This information can be useful in debugging a report or finding performance bottlenecks.
Parameters filename SRW.MASK := SRW. Adds the new information to the end of the file. SRW.dat. SRW.TRACE_ APPEND SRW. You specify which tracing options should be applied by defining a mask.TRACE OPTS opts
Is the name of the file in which Report Builder stores logging information. SRW.TRACE_ERR + SRW.TRACE_START.
Syntax
SRW.TRACE_REPLACE|SRW.TRACE_END.TRACE_START(test.
The following example specifies three tracing options and then invoking them in a call to SRW.TRACE_opts . To stop the logging.MASK := SRW.TRACE_ REPLACE SRW. You can also specify what information you want included in the log file.MASK.TRACEOPTS). you do the following:
1 2
Specify the options you want turned on. .TRACE_APPEND}.TRACEOPTS.TRACEOPTS when you call the SRW.
122
Report Builder Reference
. SRW.TRACE_START procedure. . Apply the options to the object by using SRW.

TRACE_ Includes trace information on all the PL/SQL objects in the PLS log file.TRACE_ Includes all possible trace information in the log file.SRW. PRF SRW.TRACE_ Includes performance statistics in the log file.TRACE_ Includes trace information on all the SQL in the log file.TRACE_ Lists distribution lists in the log file.rdf file. SQL
SRW.rep file.
Report Builder Reference
123
.TRACE_START automatically ends any other log sessions. Only one log session is allowed at one time.TRACE_ Includes error messages and warnings in the log file. SRW. BRK SRW. ALL SRW. SRW.TRACE_START restrictions
• • Logging information can only be generated when running a . You cannot specify logging when running a .MASK
The options that you can apply to a trace mask are: Mask Option Description SRW.TRACE_ Lists breakpoints in the log file. You can use this DST information to determine which section was sent to which destination.TRACEOPTS.TRACE_ Includes trace information on all the report objects in the log APP file. SRW. ERR SRW. SRW.

You could handle this exception ** in the following way: */ EXCEPTION when SRW.TRUNCATED_VALUE then srw.
124
Report Builder Reference
. Syntax
SRW.
If the error resulted from a user exit IAF PUT.TRUNCATED_VALUE.TRUNCATED_VALUE exception is handled. this message will be displayed:
REP-1435: Value of column <parameter/column name> was truncated. the value will be truncated and remain assigned to the parameter or column. ’Contact Dan Brown: SRW.
Usage Notes Reports raises this exception when a user exit or PL/SQL construct attempts to assign a value to a parameter or column which is larger than the object’s maximum width.
SRW.message(2000.TRUNCATED_VALUE.TRUNCATED_VALUE example
/* Suppose you want your own error message raised.’).TRUNCATED_VALUE
Description This exception will stop the report execution and raise one of two error messages. this message will be displayed:
REP-1416: User exit <name> IAF PUT: value of column <parameter/column name> was truncated. instead of the ** default error message (above).SRW. If the error resulted from a PL/SQL assignment.
If the SRW.

Report Builder Reference
125
.
Usage Notes Reports raises this exception when the SRW.UNKNOWN_QUERY. ** You could handle this exception in the following way: */ EXCEPTION when SRW. raise srw.message(4000.UNKNOWN_QUERY.SET_MAXROW packaged procedure is called with an unknown query.SRW.SET_MAXROW.UNKNOWN_QUERY
Description This exception will stop the report execution and raise the following error message:
REP-1427: Nonexistent query name referenced in SRW. ’Contact Per Jensen: SRW.UNKNOWN_QUERY then srw. ** instead of the default error message (above).
SRW.’).UNKNOWN_QUERY example
/* Suppose you want your own error message raised.program_abort.
Syntax
SRW.

g. instead of the default error message (above).
126
Report Builder Reference
. EXCEPTION WHEN srw. this exception stops the report execution and raises the following error message:
REP-1415: Unknown user exit.unknown_user_exit then srw. ’PASS USER EXIT WAS UNKNOWN. The following PL/SQL will raise a customized error message for SRW. because the user exit was not linked).USER_EXIT20 packaged procedure cannot be located (e.UNKNOWN_USER_EXIT
Description If your user exit is unknown (e.
Usage Notes Reports raises this exception when the user exit specified for the SRW...UNKNOWN_USER_EXIT example
Suppose you want your own error message raised.g.message(200.
SRW.UNKNOWN_USER_EXIT.
Syntax
SRW. CHECK IF IT’’S LINKED. because it is not linked).’).SRW.USER_EXIT or SRW.UNKNOWN_USER_EXIT.

CHECK ITS CODE. ’FOUND A NEGATIVE SALARY. CHECK THE EMP TABLE.MESSAGE(200. END IF.
Report Builder Reference
127
. ’STORE USER EXIT FAILED. SRW.USER_EXIT example
/* ** ** ** */ Suppose you have a user exit named STORE to which you want to pass salary values from Report Builder.
Parameters user_exit_string Is the name of the user exit you want to call and any columns or parameters that you want to pass to the user exit program. If your report must be portable.
SRW.
SRW.USER_EXIT_FAILURE THEN SRW.REFERENCE(:SAL).USER_EXIT
Description This procedure calls the user exit named in user_exit_string. see Calling a user exit.REFERENCE must be called before this procedure.’).USER_EXIT(’STORE SAL’). For more information on how to call user exits. RETURN(TRUE). n If the user exit string passes a column or parameter to the user exit program. ELSE SRW. use PL/SQL. you could write the following formula.USER_EXIT restrictions
n User exits are not portable.USER_EXIT (user_exit_string CHAR).’). Syntax
SRW. To do so.MESSAGE(100.MESSAGE(200.SRW. EXCEPTION WHEN SRW.’). ’STORE USER EXIT WAS UNKNOWN. SRW. CHECK IF IT’’S LINKED. and you need to add conditional logic to it.UNKNOWN_USER_EXIT THEN SRW. It is useful when you want to pass control to a 3GL program during a report’s execution. WHEN SRW.
FUNCTION FOO RETURN BOOLEAN IS BEGIN IF :SAL >= 0 THEN SRW.

128
Report Builder Reference
.END.

SRW.USER_EXIT20 passes the following when calling a user exit:
n the character string that you specify n a pointer to the length of the character string n an error string (This argument is not used by Report Builder and will always pass a value of ’ ’.
Parameters user_exit_string Is the name of the user exit you want to call and any columns or parameters that you want to pass to the user exit program.USER_EXIT20 (user_exit_string CHAR).SRW.)
Syntax
SRW. such as Oracle Forms.) n a pointer to the length of the error string (This argument is not used by Report Builder and will always pass a value of 0. which pass five arguments instead of two. except that it calls the user exit with five arguments instead of just two. This enables you to share user exits with other Oracle products.USER_EXIT passes the following when calling a user exit:
n the character string that you specify n a pointer to the length of the character string
SRW.USER_EXIT20
Description This procedure is the same as SRW.USER_EXIT.
Report Builder Reference
129
.) n an in query argument (This argument is not used by Report Builder and will always pass a value of 0.

USER_EXIT_FAILURE
Description This exception is raised when the user exit you called has failed.USER_EXIT_FAILURE then SRW.USER_EXIT_FAILURE example
/* Suppose you want your own error message raised.
Syntax
SRW.MESSAGE(200. When called.
Usage Notes Reports raises this exception when the SRWERB buffer is non-empty.USER_EXIT_FAILURE. The following PL/SQL code will ** raise a customized error message for SRW.
SRW.SRW. */ EXCEPTION when SRW.’). ’PASS user exit failed. instead of the ** default error message (above). Check its code.
130
Report Builder Reference
.USER_EXIT_FAILURE. it stops the report execution and raises the following error message:
REP-1416: User exit <exit_name> failed.

Triggers
Report Builder Reference
131
.

Before Parameter Form Fires before the Runtime Parameter Form is displayed. such as deleting tables.) Any processing that will not affect the data retrieved by the report can be performed in the other triggers. From this trigger. and report-level columns. Consequently. Consequently. or after report output is sent to a specified destination. This trigger can also be used to change parameter values or. however. After Parameter Form Fires after the Runtime Parameter Form is displayed. such as a file.
132
Report Builder Reference
. except the very first page. Columns from the data model are not accessible from this trigger. you can use this trigger for validation of command line parameters. any processing that will affect the data retrieved by the report should be performed in the Before Parameter Form or After Parameter Form triggers. this trigger only fires the first time that you go to a page. PL/SQL global variables. You cannot create new global report triggers. (These are the two report triggers that fire before anything is parsed or fetched. whether or not your report completed successfully. In the Previewer. If the Runtime Parameter Form is suppressed. If you subsequently return to the page. the trigger does not fire again. you can access parameters and check their values. you can use this trigger for validation of command line parameters or other data. After Report Fires after you exit the Previewer. or an Oracle Office userid. the After Parameter Form trigger still fires. Note. this trigger still fires. that this trigger always fires. If the Runtime Parameter Form is suppressed. Report Builder has five global report triggers. The trigger names indicate at what point the trigger fires: Before Report Fires before the report is executed but after queries are parsed. a printer. Between Pages Fires before each page of the report is formatted. From this trigger. This trigger can be used to clean up any initial processing that was done. if an error occurs. return to the Runtime Parameter Form.Which report trigger to use
As a general rule. This trigger can be used for customized page formatting. you can access and change the values of parameters.

Report Builder Reference
133
.

Report trigger order of execution
The order of events when a report is executed is as follows: Before Parameter Form trigger is fired. Report is "compiled. In steps 7 through 9.." Queries are parsed. avoid DML statements that would modify the contents of the tables on which the report is based.DO_SQL with DDL. is executed based on what was specified via the ONSUCCESS argument or setting.g. COMMIT is executed (if READONLY is specified) to end the transaction. avoid DDL statements that would modify the tables on which the report is based. After Report trigger is fired. When you execute a DDL statement (e. Step 3 takes a snapshot of the tables and the snapshot must remain valid throughout the execution of the report.) COMMITs can occur during this time due to any of the following--user exit with DDL. a COMMIT is automatically issued. SRW. via SRW. Queries may be executed in any order. n If you specify READONLY. After Parameter Form trigger is fired (unless the user cancels from the Runtime Parameter Form). SET TRANSACTION READONLY is executed (if specified via the READONLY argument or setting).
134
Report Builder Reference
. and the report fails. (Note that data can be fetched at any time while the report is being formatted. you should avoid DDL altogether.DO_SQL or a user exit). which makes DML statements unreliable (unless performed on tables not used by the report).
3 4 5 6
7
8 9
10 COMMIT/ROLLBACK/NOACTION
Cautions
n In steps 4 through 9. The report is executed and the Between Pages trigger fires for each page except the last one. or if ONFAILURE=COMMIT.
1 2
Runtime Parameter Form appears (if not suppressed). If you are using READONLY. Before Report trigger is fired. this will prematurely end the transaction begun by SET TRANSACTION READONLY.

even though you have not yet seen a page. After Parameter Form. you must specify the value in the After Parameter Form trigger or earlier. In the Before and After Report triggers. you can set the values of parameters (e. Note. it may already have been formatted and the trigger fired.g. Note also that the use of PL/SQL global variables to indirectly set the values of columns or parameters is not recommended. For example.RUN_REPORT). suppose you have a query like the following (note that the WHERE clause is replaced by a lexical reference):
SELECT ENAME. though. a total number of pages displayed before the last page). SAL FROM EMP &where_clause
If the value of the WHERE_CLAUSE parameter contains a reference to a bind variable. that you cannot reference any page-dependent columns (i.g. you should commit database changes you make in the Before Parameter Form.e. however. n In report triggers. For example. you can use the values of report-level columns and parameters. n A lexical reference cannot be used to create additional bind variables after the After Parameter Form trigger fires.
WHERE SAL = :new_bind
Report Builder Reference
135
. suppose that you use SRW.e. Hence.. If you supplied this same value in the After Parameter Form trigger. you cannot set the values of any data model objects. it will establish its own database connection. these triggers will share the parent process’ database connection.. IF :COUNT1 = 10). you may get unpredictable results. You would get an error if you supplied the following value for the parameter in the Before Report trigger. and Before and After Report triggers. n If you run a report from Report Builder Runtime (i.. :COUNT1 = 15). and Validation triggers before the report runs. When the report is actually executed. placeholder columns. you might need to use the value of a parameter called COUNT1 in a condition (e.Report trigger restrictions
n If you are sending your report output to the Runtime Previewer or Live Previewer..g. n In the Before and After Parameter Form. If there are forward references in the report (e. For example. Report Builder may have to format ahead to compute the forward references. When running in this way. n In the Between Pages trigger. you can also set the values of report-level.MESSAGE to issue a message in the Between Pages trigger when a condition is met.. not the command line or SRW. If you do this. the report would run. a column with a Reset At of Page) or columns that rely on page-dependent columns. you should note that some or all of the report triggers may be fired before you see the report output. give them a value in an assignment statement.

or the PL/SQL Editor.g.g..
Group filter restrictions
n Group filters cannot be added to groups if Filter Type is First or Last.
Group filter example
function filter_comm return boolean is begin if :comm IS NOT NULL then if :comm < 100 then return (FALSE).e. if the Filter Type property is PL/SQL. You also cannot reference any page-dependent columns (i. n In a group filters. Definition Level group On Failure Excludes the current record from the group. else return (TRUE). IF :COUNT1 = 10). If you do this. but you cannot directly set its value in an assignment statement (e. -. but you cannot directly set their values.. else return (FALSE). you can use the value of a parameter called COUNT1 in a condition (e. Reset At of Page) or columns that rely on page-dependent columns in a group filter. you can read the values of Report Builder columns and parameters of the correct frequency (look at the rule below).. For example. n Group filters cannot be added to cross-product groups. end. the current record is included or excluded from the report. n The function that you enter for a group filter can only depend upon the following columns: n a database column owned by the group’s query or a query above it in the data model hierarchy
136
Report Builder Reference
.for rows with NULL commissions end if. :COUNT1 = 10). Depending on whether the function returns TRUE or FALSE. the Property Palette (the PL/SQL Filter property). The function must return a boolean value (TRUE or FALSE). end if. you may get unpredictable results. Note also that the use of PL/SQL global variables to indirectly set the values of columns or parameters is not supported. You can access group filters from the Object Navigator.Group filter
Description A group filter is a PL/SQL function that determines which records to include in a group.

or the group’s descendants)
Report Builder Reference
137
.. the group’s ancestors.e.n computed columns (formulas or summaries) that depend on unrelated queries (i. computed columns that do not depend upon columns in the group.

. end. the PL/SQL Editor. end. or VARCHAR2. :COMP := 15). the PL/SQL Formula property). placeholder columns.Formula
Description Formulas are PL/SQL functions that populate formula or placeholder columns. end if. Report Builder builds a dependency list.
Formula with condition example
function calcomm return NUMBER is temp number.
Formula restrictions
n In a formula. you can read and assign values to the column itself. IF :COMP = 10) and you can directly set its value in an assignment statement (e.e. You can access the PL/SQL for formulas from the Object Navigator. For example. to guarantee proper ordering of calculations.
Formula for adding values example
function salcomm return NUMBER is begin return(:sal + :comm). Definition Level column On Failure No value is returned for the column.g. in which a column references another column which in turn references the first column. begin if :comm IS NOT NULL then temp := :sal + :comm. n A formula can only make reference to columns that are in the same or a higher group in the group hierarchy.g. return (temp). For example. A column of datatype Number can only have a formula that returns a value of datatype NUMBER. and parameters of the correct frequency (look at the rule below). a formula for a report-level column can only reference other report-level columns.. VARCHAR. To do so. n Formulas are calculated such that any column referenced in the formula will be calculated first. A column of Datatype Character can only have a formula that returns a value of datatype CHARACTER. else temp := :sal. Note that circular dependencies. either directly
138
Report Builder Reference
. you can use the value of a column called COMP in a condition (e. or the Property Palette (i.. A column of Datatype Date can only have a formula that returns a value of datatype DATE.

we recommend that you do not read database values that are updated or inserted in the same report. Thus. Report Builder does internal "data look-ahead" to optimize performance. There is no guarantee of the exact time Report Builder will fetch records from the database for formatting the output. such as invocation of user exits.. a particular record might already have been accessed before an update is issued to the same record. Report Builder cannot guarantee these events will be synchronized with its internal data access or with the formatting of data. Report Builder builds internal dependency lists which guarantee that events. n When using SRW. calculation of summaries. However.
Report Builder Reference
139
.
n A user exit may only change the value of a placeholder column. etc. are not allowed.DO_SQL.or indirectly. happen in the correct order.

IF :COUNT1 = 10) and you can directly set its value in an assignment statement (e. Definition Level parameter On Failure The user is returned to the parameter value in the Runtime Parameter Form where they can either change it or cancel the Runtime Parameter Form.g. the Validation Trigger may fire more than once for the same parameter. You can access validation triggers from the Object Navigator. n You should not use DDL in Validation triggers.. For example. The function must return a boolean value (TRUE or FALSE). end. it is usually best to assign parameter values in the After Parameter Form trigger. */ function DESTYPEValidTrigger return boolean is begin IF UPPER(:DESTYPE) = ’PRINTER’ THEN RETURN(TRUE).
140
Report Builder Reference
. Note also that the use of PL/SQL global variables to indirectly set the values of columns is not supported. (Notice that this means each validation trigger may fire twice when you execute the report. n In a validation trigger.
Validation trigger restrictions
n The PL/SQL in a validation trigger can be a maximum of 32K characters. the user is returned to the Runtime Parameter Form.Validation trigger
Description Validation triggers are PL/SQL functions that are executed when parameter values are specified on the command line and when you accept the Runtime Parameter Form. the PL/SQL Editor. you may get unpredictable results. though. :COUNT1 = 15). As a result. If you do this. In some cases.) Validation triggers are also used to validate the Initial Value property of the parameter. Depending on whether the function returns TRUE or FALSE.. ELSE RETURN(FALSE).g. The upward limit may vary between operating systems.
Validation trigger example
/* This function prevents the runtime user from ** sending report output anywhere except a printer. you can read and assign values to Report Builder parameters. You cannot read or assign values to columns. ** The user will be returned to the Runtime Parameter ** Form unless PRINTER is specified as the destination ** type (DESTYPE). or the Property Palette (Validation Trigger property). END IF. you can use the value of a parameter called COUNT1 in a condition (e.

n For reports that are spawned processes of other reports (e. Spawned processes use their parent process’ database connection for the Before Parameter Form. After Parameter Form.g. and Validation triggers. After Parameter Form. When the spawned process runs the report.
Report Builder Reference
141
. run with BACKGROUND=YES). and Validation triggers before the report runs. though. you should commit database changes you make in the Before Parameter Form. Any database changes not committed by the time the child report runs will therefore be lost.. it establishes its own database connection.

2
Format trigger example (suppressing labels)
/* ** ** ** ** ** ** ** ** Suppose that you are building a master/detail report and. You can access format triggers from the Object Navigator. The function must return a Boolean value (TRUE or FALSE).BORDERWIDTH_ATTR.Format trigger
Description Format triggers are PL/SQL functions executed before the object is formatted.mask := SRW. the current instance of the object is included or excluded from the report output. if no detail records are retrieved for a master record. you enter the following:
142
Report Builder Reference
. The trigger can be used to dynamically change the formatting attributes of the object. srw. In the format trigger for the group frame that surrounds the detail repeating frame and its labels. if a format trigger returns FALSE for a field. you first create a summary column called MYCOUNT with a Function of Count in the source group of the master repeating frame.attr). end if.
Format trigger example (highlighting a value)
/* Suppose that you are building a banking report and ** would like it to indicate if a customer is overdrawn. To do this. srw. the data for the field is retrieved even though the field does not appear in the output.attr. or the PL/SQL Editor. return (true). srw. ** To do so. For example. you give the repeating frame around the ** customer information a format trigger that causes ** it to have a border only if a customer’s account ** balance is less than 0 (or the required minimum **balance). Depending on whether the function returns TRUE or FALSE. Usage Notes
n Format triggers do not affect the data retrieved by the report.set_attr (0. end. Definition Level layout object On Failure Excludes the current instance of the object from the output. */ function my_formtrig return BOOLEAN is begin if :bal < 0 then srw.borderwidth := 1. n If a format trigger suppresses report output on the last page of the report. you do not want the boilerplate labels to appear. the last page will still be formatted and sent to the appropriate output and the page will be included in the total number of pages. the Property Palette.attr.

*/ function my_formtrig return BOOLEAN is begin if :ename <> :lastname then return (true). however.
Format trigger example (suppressing values)
/* Suppose that you are building a salary report and ** you only want to see salaries above $2500. ** LASTNAME is a summary column with a Source of ENAME. else return (false). In the ** report summary of all salaries. To ensure that the comma does ** not appear after the last name in the list. format triggers should only contain
Report Builder Reference
143
. */ function my_formtrig return BOOLEAN is begin if :sal > 2500 then return (true). As a result. you create a ** data model for the report without restricting the records ** retrieved. but the summary that ** calculates the sum of all salaries will include all the ** salaries retrieved from the database. end. you enter the following format trigger ** for the repeating frame. enter the ** following format trigger for the boilerplate object.*/ function my_formtrig return BOOLEAN is begin if :mycount = 0 then return (false). Then. and Reset At of Report. else return (true). Next to the field. end. you create ** a field inside a repeating frame with a Print ** Direction of Across. you create ** a boilerplate text object that contains a comma ** followed by a space. First. ** a Function of Last.
Format trigger example (placing a comma between fields)
/* Suppose that you want to create a comma-separated ** list for the names of employees. end if. To do this.
Format trigger restrictions
Caution: The PL/SQL in a format trigger is executed each time that Report Builder attempts to format the layout object. else return (false). The report output will only ** show salaries greater than $2500. you want all ** salaries to be included. end if. end if. end.

You also cannot reference any page-dependent columns (i. if a repeating frame does not format. but you cannot directly set their values. the parent group’s repeating frame cannot have a format trigger that relies on a value in the child group. you may get unpredictable results. For example.. such as inserting data in a table. the repeating frame will occupy no space on the logical page and anchors to other objects will collapse (if specified). but the report cannot be formatted until the format trigger is executed. this can cause other objects not to print. boilerplate. (This restriction also applies to user exits called from the format trigger. the last page be a blank page. n Comments inserted directly into the PL/SQL code must use the PL/SQL comment delimiters. For example.e..PL/SQL program units that set formatting attributes (e. frames. the trigger may be executed more than once.
n If a f2ormat trigger returns false for an object on the last page of your report and no other objects are formatted on the last page. the object might not be formatted on the logical page where the trigger is fired. Reset At of Page) or columns that rely on page-dependent columns in a format trigger.. Therefore. n The PL/SQL in a format trigger must return consistent results for the same object. You should not perform other actions. IF :COUNT1 = 10). That is. at the parent record level. If you do this. For each parent. In addition. you can use the value of a parameter called COUNT1 in a condition (e.. there may be multiple children. n You cannot reference columns or variables in the format trigger of an object that have a different frequency than the object.g. n In a format trigger. but you cannot directly set its value in an assignment statement (e. the value of a page-dependent column cannot be computed until the report is formatted.) Note also that the use of PL/SQL global variables to indirectly set the values of columns or parameters is not supported. say you have a frame whose format trigger returns FALSE when a
144
Report Builder Reference
. create a frame around the repeating frame and enter a format trigger for the frame.g. For example. n If a format trigger returns false and the object does not format. because you cannot predict when or how many times the trigger will fire. you can read the values of Report Builder columns and parameters of the correct frequency (look at the rule below). To create a format trigger that acts upon all instances of a repeating frame at once. or other repeating frames) it encloses would not format either. :COUNT1 = 10). Report Builder cannot determine which of the child records to use. n For repeating frames. the format trigger is executed for each instance of the repeating frame. For example. if you have Page Protect set for an object. The reason for this is that it would result in a circular dependency. color and highlighting). If the format trigger returns FALSE for every instance of a repeating frame on a logical page. if you create a master/detail report.g. For example. any objects (fields.

but the part on the second page does not). you should put a frame around the field inside the matrix and use the format trigger for the frame. only part of the frame will be formatted (e.g. For example.certain condition is met.
Report Builder Reference
145
. If the frame spans two pages.. the format trigger actually fires twice (once for each page on which the frame formats). if an instance of the across dimension repeating frame does not format. n If you want to conditionally change the cell of a matrix. Otherwise. an entire row or column of the matrix will not format. the entire column will not format in the matrix. The condition in your PL/SQL must return the same result both times the format trigger fires. the part of the frame on the first page formats.
n If the format trigger on a repeating frame in a matrix report returns FALSE.

You can access action triggers from the Object Navigator. then displays ** the resulting report output on your screen. To get around this.Action trigger
Description Action triggers are PL/SQL procedures executed when a button is selected in the Runtime Previewer.rdf destype=Screen paramform=yes’).run_report(’module=web4. */ procedure U_1ButtonAction is begin srw.
Action trigger example
/* When the button is clicked. or the PL/SQL Editor. n You cannot use the PL/SQL Interpreter to debug action triggers because it is not available from the Runtime Previewer and buttons cannot be activated in the Live Previewer. Definition Level button Usage Notes
n PL/SQL action triggers cannot be tested in the Live Previewer because the buttons are not active there. The trigger can be used to dynamically call another report (drill down) or execute any other PL/SQL.
146
Report Builder Reference
. the action trigger ** defined by this procedure displays the Parameter ** Form for a report named web4. the Property Palette (PL/SQL Trigger property). end. you can move your action trigger code to a report trigger to test it from the Live Previewer. You must use the Runtime Previewer (choose View Runtime Preview from the Live Previewer).rdf.

Report Builder Reference
147
.
Package with ref cursor and function example
/* This package spec and body define a ref ** cursor type as well as a function that ** uses the ref cursor to return data. ** The function could be referenced from ** the ref cursor query. In a ref cursor query. compensation number). If creating this spec ** and body as a stored procedure in a ** tool such as SQL*Plus. END. you would need ** to use the CREATE PACKAGE and CREATE ** PACKAGE BODY commands. ename varchar(10). */ PACKAGE cv IS type comp_rec is RECORD (deptno number. */ PACKAGE cv IS type comp_rec is RECORD (deptno number. you specify a PL/SQL function that returns a cursor value from a cursor variable. type comp_cv is REF CURSOR return comp_rec. compensation number). Definition Level query On Failure No data is returned to the query.
Package with ref cursor example
/* This package spec defines a ref cursor ** type that could be referenced from a ** ref cursor query function. ** you would need to use the CREATE ** PACKAGE command. type comp_cv is REF CURSOR return comp_rec. you receive the added benefits that go along with storing your program units in the Oracle database. Usage Notes
n n
When you make a ref cursor query the child in a data link. the link can only be a group to group link. If you use a stored program unit to implement ref cursors. which would ** greatly simplify the PL/SQL in the ** query itself. ename varchar(10). ** If creating this spec as a stored ** procedure in a tool such as SQL*Plus.Ref cursor query
Description A ref cursor query uses PL/SQL to fetch data for the report. It cannot be a column to column link.

** Note this example assumes you have defined ** a user parameter named deptno. 1.comp_cv ** ref cursor from the cv package to return ** data for the query.comp_cv is temp_cv cv.
Ref cursor query calling function example
/* This ref cursor query function would be coded ** in the query itself.0)) compensation from emp where deptno = deptno1. end if..comp_cv ** ref cursor and the cv. return temp_cv. Query ** administration/maintenance can be ** done at the package level (e. 1. ename. end if.0)) compensation from emp where deptno = :deptno.comp_cv is
148
Report Builder Reference
. end. ename. You could also ** easily move the package to the database.25*(sal+nvl(comm. ename.comp_cv. PACKAGE BODY cv IS function emprefc(deptno1 number) return comp_cv is temp_cv cv. 1. else open temp_cv for select deptno. the logic for the query resides ** mainly within the package. END.0)) compensation from emp where deptno = deptno1. END. */ function DS_3RefCurDS return cv. end.15*(sal+nvl(comm. ** modifying SELECT clauses could be done ** by updating the package). else open temp_cv for select deptno.comp_cv.0)) compensation from emp where deptno = :deptno. ** Because it uses the function from the cv ** package.25*(sal+nvl(comm. begin if deptno1 > 20 then open temp_cv for select deptno. return temp_cv.15*(sal+nvl(comm.
Ref cursor query example
/* This ref cursor query function would be coded ** in the query itself.emprefc function from ** the cv package to return data for the query. 1.function emprefc(deptno1 number) return comp_cv. It uses the cv. begin if :deptno > 20 then open temp_cv for select deptno. ename.g. It uses the cv. */ function DS_3RefCurDS return cv.

Definition Level report On Failure Returns to the Runtime Parameter Form. return to the Runtime Parameter Form. you can use this trigger for validation of command line parameters or other data.After Parameter Form trigger
Description The After Parameter Form trigger fires after the Runtime Parameter Form is displayed. the After Parameter Form trigger still fires. then returns to place from which you ran the report. This trigger can also be used to change parameter values or. Consequently. if an error occurs. Columns from the data model are not accessible from this trigger. If the Runtime Parameter Form is suppressed. From this trigger. If the Form is suppressed. you can access parameters and check their values.
150
Report Builder Reference
.

to indicate that the report did not run correctly. though. Definition Level report On Failure Does not affect formatting because the report is done. For example. If the report took longer than a certain time to run. you could put the system time in a variable in the Before Report trigger and then compare it against the system time in the After Report trigger. You can raise a message. or after report output is sent to a specified destination. or a mailid. such as a file. however. you could raise an error. Usage Notes
n The After-Report trigger does not fire when you are in the Live Previewer. that this trigger always fires.
Report Builder Reference
151
. Note. a printer. such as deleting tables. This trigger can be used to clean up any initial processing that was done. whether or not your report completed successfully.After Report trigger
Description The After Report trigger fires after you exit the Runtime Previewer.

Before Parameter Form trigger
Description The Before Parameter Form trigger fires before the Runtime Parameter Form is displayed. you can use this trigger for validation of command line parameters. Consequently. and report-level columns. From this trigger. this trigger still fires. PL/SQL global variables.
152
Report Builder Reference
. Definition Level report On Failure Displays an error message and then returns to the place from which you ran the report. If the Runtime Parameter Form is suppressed. you can access and change the values of parameters.

Report Builder Reference
153
. Definition Level report On Failure Displays an error message and then returns to the place from which you ran the report.Before Report trigger
Description The Before Report trigger fires before the report is executed but after queries are parsed and data is fetched.

the first page is displayed. Definition Level report On Failure Displays an error message when you try to go to the page for which the trigger returned FALSE. If you subsequently return to the page. except the very first page. If the trigger returns FALSE on the last page. but. if you try to go to the second page. The pages subsequent to the page that returned FALSE are not formatted. If the trigger returns FALSE on the first page. This trigger can be used for customized page formatting. In the Runtime Previewer or Live Previewer. this trigger only fires the first time that you go to a page.Between Pages trigger
Description The Between Pages trigger fires before each page of the report is formatted. an error message is displayed.
154
Report Builder Reference
. The Between Pages trigger does not fire before the first page. the trigger does not fire again. nothing happens because the report is done formatting.

Properties
Report Builder Reference
155
.

STATE.
Summaries. For example. For example.Oracle8 usage notes
Column objects and Ref columns
n To reference the attribute columns or methods of a column object. You can only use their individual attribute columns in links. suppose you have a column object named ADDRESS that is composed of STREET. Only the name is updated to indicate the association with the column object (e. it is detached from the column object and is treated like any other column. n A column object or Ref column must reside in the lowest group in which one of its attribute columns resides. As a result.e. ADDRESS_ZIP). If the column object or Ref column is in a group above one of its attribute columns.street. break on the attribute columns of a column object. This occurs when the frequency of the column object or Ref column is the same as the attribute column with the highest frequency.address. When you move an attribute column outside of its associated column object.
e. STATE or ZIP can be the source for a field. however. but their attribute columns can be used as bind variables. and ZIP. CITY). CITY.g. suppose you have a column object named ADDRESS composed of STREET. n You cannot break on a column object or a Ref column. ADDRESS cannot be the source for a field. n Column objects cannot be used as bind variables (i. and ZIP. n Column objects cannot be the source for a layout object. e. suppose the column object ADDRESS is in a group named G_MASTER and one of its attribute columns is ZIP. but their attribute columns can be used as the source for a layout object.. you must qualify the name with a table alias or correlation variable.. then ADDRESS must also be moved into G_DETAIL. For example. CITY. CITY. You can. you could drag the column object and all of its attribute columns into the break group and assign a break order to as many of the attribute columns as you like. then its frequency will be too low and an error is raised. You can create a link using any one of the attribute columns of ADDRESS (e. but STREET. For example: select e.city from emp e
n You can move column objects or Ref columns as a whole or move their individual attribute columns. a column object or Ref column cannot be the only column in a break group. formulas.address.g. :column_name). and placeholders
156
Report Builder Reference
.. If you drag ZIP into a child of G_MASTER called G_DETAIL. STATE.empno. n You cannot use column objects or Ref columns in data model links. For example.

CHAR or VARCHAR).
Report Builder Reference
157
.n The datatype of a formula or placeholder column must be one of the Oracle7 built-in datatypes (e. a special icon will appear next to it in the Data Model view indicating that it is not supported.g. The datatypes that are new with Oracle8 are not yet supported. n Summary columns that have a column object or Ref column as their source can only use the First. and Count functions. Large objects (LOBs) n LOBs are not supported yet. Varying arrays and nested tables n Varying array and nested table types are not supported yet. Last. a special icon will appear next to it in the Data Model view indicating that it is not supported. If you select a LOB in a query. If you select a column object of these types in a query..

a text field. The Property Palette features:
n n n n n n
expandable and collapsible nodes in-place property editing search features multi-selection complex property dialogs the ability to invoke multiple instances of the Property Palette
When you select an object in an editor or in the navigator. Set Property Controls When a property is selected in the properties list. the list of properties in the palette is synchronized whenever you select a different object. no properties are displayed in the list. and set object properties. The Property Palette has the following features: Property List The property list is a 2-column list of property names and property values. You can select properties in the list by clicking and by navigating with the Up/Down arrow keys. You can set properties in the property list pane by selecting the property and then typing or double-clicking as required. combo box. such as General Info properties and Field properties. the Property Palette is updated to show the properties of that object. you can pin the current Property Palette and invoke additional Property Palettes as needed.About the Property Palette
The Property Palette has an outline-style interface that enables you to view. When no objects are selected. When you need to compare the properties of objects. When multiple objects are selected at the same time. locate. a list of names is displayed at the top of the Property Palette. Name The name field displays the name of the object currently selected in the navigator or an editor. as follows:
158
Report Builder Reference
. or More button is displayed beside the property. pop-list. The Name field is not displayed when no objects are selected. You can turn synchronization On or Off for a specific palette by clicking the Freeze/Unfreeze tool) on the Property Palette toolbar. Properties are grouped under functional or object headings. By default.

or has a fixed set of valid values. The Property Palette is where you set the properties of objects you create in documents. Makes the current property local (i. the common setting is displayed. but does not affect the setting of any property. Body..
About making multiple selections in the Property Palette
You can select multiple objects at the same time by using Shift+Click or Ctrl+Click in the navigators or the editors. a list of object names is displayed at the top of the Property Palette. Is a string that you want to search for in the Property
Localize
Find field
Report Builder Reference
159
. Sets the current property to its default setting. Headings. Selecting the button invokes a dialog where you enter the required information. the string ***** is displayed. Intersection The default. Headings. Click once on the icon for the command you want to execute. You can select multiple properties and click Localize. A combo box is displayed when the current property can be set by typing a value or selecting from a poplist.e. You can select multiple properties and click Inherit. and the property setting is displayed as follows:
n n
If the property has the same setting for all of the selected objects that have it in common. Body. You can cycle through the values by double-clicking repeatedly. When two or more objects are selected. Properties that are common to two or more objects in a multiple selection are listed only once.. there is an iconic button next to the text field that invokes a modal editor. The Intersection/Union command on the property palette toolbar determines which properties are displayed in the property list when more than one object is selected. A More. Only properties common to all selected objects are displayed. Union All properties of every object selected are displayed. Toggling between Intersection and Union changes the list of properties displayed in the property palette.. and Summaries in templates.
About toolbar commands in the Property Palette
The toolbar provides quick access to commands. and Summaries in templates. Inherit Applies only to Sections. button is displayed when the current property requires more complex values. not inherited). A poplist is displayed when the current property is either True/False.A text field is displayed when the current property can be set by entering a text value. Applies only to Sections. If the property is set differently for the objects that have it in common. For properties that require longer text values.

Toggles Property Palette synchronization On and Off. choose Property Palette. When Freeze is On. the properties of all objects in the current selection are displayed.
160
Report Builder Reference
. To invoke a second Property Palette. only properties that the selected objects have in common are displayed. This option determines which properties appear when more than one object is selected at a time (a multiple selection). the property list is pinned and does not get updated. then choose Tools Property Palette. In intersection mode (the default).
Closing the Property Palette
To close the Property Palette:
Double-click the Close box in the upper left corner. do one of the following:
n n n n
Double-click the object. the property list is updated to display the properties of objects you select in the navigators and other windows. Double-click the properties icon for the object in the Object Navigator. allowing you to compare it to other property lists. Searches forward for the string in the Find field.
Freeze/Unfreeze
Displaying the Property Palette
To display the Property Palette for an object. Toggles the Property Palette between union and intersection display modes. Click the object. Searches backward for the string in the Find field. When Freeze is Off (the default).Find forward Find backward Intersection/ Union
Palette. you must pin the current one and double-click an object icon. In union mode.
From the pop-up menu (right-click in Windows).

or More. The objects can be of different types and can even be in different documents. a text field. combo box.
Setting properties of multiple selections example
A report includes several fields.
You can select properties by clicking or by navigating with the Up/Down arrow keys. then set the Format Mask property once to change the format mask for each item selected. When a property is selected. To use a different date format throughout the application.Setting properties using the Property Palette
To set properties using the Property Palette: 1 2
Display the Property Palette for the object whose properties you want to set. each of which displays the date.
Any change you make to a property setting is applied to all of the objects in the current selection to which that property applies. Rather than setting each field’s Format Mask property individually. you need to set the Format Mask property for each field that displays dates. select the objects whose properties you want to set.
(the Intersection tool) to see only the properties the objects
4
Set the properties as desired. poplist.
Comparing the properties of one object to another
To compare the properties of one object to another: 1
In the Object Navigators or the editors. Select the property you want to set. click or leave the tool as have in common. The Datatype property of each field is DATE.
Setting properties of multiple selections
To set the properties of multiple selections: 1
In the Object Navigator or the editors. Choose Tools Property Palette. button is displayed next to the property... double-click the first object so that its
Report Builder Reference
161
. which causes dates to be displayed in the default ORACLE format DD-MON-YY.
1
Set the property to the desired setting. (the Union tool) to see all properties of all objects
2 3
In the Property Palette. select all of the items.

click Property Palette. click the second object.
162
Report Builder Reference
. If the second window is on top of the first.
A second Property Palette is displayed. then choose Property Palette from the pop-up menu.
2
In the Property Palette.
to turn synchronization Off and "freeze" the
3
In the Object Navigator.properties are displayed in the Property Palette. drag it to move it alongside the first window.

In addition.e. they may not be the parent or child object for an anchor). it can be the parent but not the child object for an anchor). and field C is the parent. Nothing can be anchored to a hidden object (an object with Visible set to No). but other objects may be anchored to it (i. A repeating frame that is the vertical or horizontal repeating frame for a matrix cannot be anchored to another object. object B cannot be the parent for an anchor to object C. Object B cannot be the parent for another anchor between object A and object B. Field C cannot be the parent for an anchor to field B. field B cannot be anchored to field C. Matrix objects.
See the online help for details and illustrations. Moving an anchor also causes the two objects it anchors together to move. and the margin cannot be anchored to anything (i.. which is not inside of frame A. Furthermore. Objects cannot be anchored together in such a way that they have a circular dependency.Anchor properties
Child Edge Percent Child Edge Type Child Object Name Collapse Horizontally Collapse Vertically Comments Name Parent Edge Percent Parent Edge Type Parent Object Name
Anchor restrictions
n n n
An object may be anchored to only one other object.. anchors.
n Assume that frame A contains field B and field B is above frame A in the Layout Model. For example:
n n n
n Assume that object A and object B are anchored together and object A is the parent.e. Because it is inside of frame A. frame A is anchored to field C. if field
Report Builder Reference
163
. if object C is the parent for an anchor to object A.

Report Builder prevents you from moving the anchor to a layer below its parent and child objects. or Size Objects from the Arrange menu on anchors.e.C is the parent. Align Objects. You cannot use Align. you must select the anchor and the two objects it anchors together. If you select the anchor and one of the objects. nothing will be copied to the paste buffer. An anchor cannot be resized.. it must be one or more layers above the parent and child objects). only the object is placed in the clipboard. An anchor must always be on top of the objects it anchors together (i.
n
To copy an anchor. See the online help for details and illustrations. If you select the anchor by itself.
n n
n
164
Report Builder Reference
.

Values An integer from 0 through 100.Child Edge Percent
Description The Child Edge Percent property is the percentage down or across (from top to bottom or left to right) the child object’s edge where the anchor is located. Applies to anchors
Report Builder Reference
165
. This setting is the position of the anchor on the edge when the object is populated.

Values Top.Child Edge Type
Description The Child Edge Type property is the edge of the child object on which the anchor is located. Left. Bottom. and Right Applies to anchors
166
Report Builder Reference
.

This field is read-only.Child Object Name
Description The Child Object Name property is the name of the child object. Applies to anchors
Report Builder Reference
167
.

g. If the parent object does not print. or Format Trigger properties). Base Printing On.Collapse Horizontally
Description The Collapse Horizontally property indicates whether the anchor should have zero width if the parent object does not print for some reason (e. the child object moves horizontally into the space vacated by the parent.. because of its Print Object On. Applies to anchors
168
Report Builder Reference
.

See the online help for details and illustrations. Draw an anchor from the center of the top of the field to the center of the top of the repeating frame. Applies to anchors
Centering fields horizontally example
Suppose you want to horizontally center a field within a repeating frame that has its Horizontal Elasticity set to Variable. Since you don’t know how large or small the formatted repeating frame will be. where Field A does not appear. Since Collapse Vertically is set to Yes. Assume that on the first logical page of the report. Since you don’t know how large or small the formatted repeating frame will be. Field A prints and takes up so much room that Field B cannot fit on the logical page. If the parent object does not print. Therefore. Tip The field will now be centered horizontally within the repeating frame. the
Report Builder Reference
169
. See the figure below..g. See the online help for details and illustrations. Base Printing On. You also want the field to be a fixed distance from the top edge of the repeating frame. To center the field horizontally within the repeating frame do the following:
n
Place the field inside the repeating frame such that the x coordinate of the center of the top of the field is the same as the x coordinate of the center of the top of the repeating frame. To center the field vertically within the repeating frame.Collapse Vertically
Description The Collapse Vertically property indicates whether the anchor should have zero height if the parent object does not print for some reason (e.
n
Centering fields vertically example
Suppose you want to vertically center a field within a repeating frame that has its Vertical Elasticity set to Variable. Tip The field will now be centered vertically within the repeating frame. draw an anchor from the center of the left edge of the field to the center of the left edge of the repeating frame. the child object moves vertically into the space vacated by the parent. See the online help for details and illustrations. you need to use anchors to center the field. or Format Trigger properties).
Collapse Vertically example (field)
Suppose that you have anchored Field B to Field A and Collapse Vertically is set to Yes. you need to use anchors to center the field. You also want the field to be a fixed distance from the top edge of the repeating frame. because of its Print Object On. Field B prints on the second logical page.

When Fields A and B do print on the same logical page. On the first logical page of the report. Set both Collapse Horizontally and Collapse Vertically to Yes. where Field A does not appear. The anchor collapses and Field B moves into the position that Field A would have appeared in had it appeared on the logical page as painted.
170
Report Builder Reference
. Do the following:
n n
Draw an anchor from the top of Field B to the bottom of Field A. Field A prints and takes up so much room that Field B cannot fit on the logical page. Therefore. See the online help for details and illustrations. See the online help for details and illustrations.anchor collapses in the y direction. See the online help for details and illustrations. Field B prints on the second logical page. and you want Field B to move both vertically and horizontally into the space where Field A would have printed on the logical page.
Collapse Vertically and Horizontally example (field)
Suppose that you have anchored Field B to Field A. Field B maintains its relative positioning to Field A in the x direction even though Field A does not actually appear on the logical page. the anchor does not collapse and the fields maintain their relative position to one another.

Values An integer from 0 through 100.Parent Edge Percent
Description The Parent Edge Percent property is the percentage down or across (from top to bottom or left to right) the parent object’s Edge where the anchor is located. This setting is the position of the anchor on the Edge when the object is populated. Applies to anchors
Report Builder Reference
171
.

Parent Edge Type
Description The Parent Edge Type property is the edge of the parent object on which the anchor is located. Values Top. Left. and Right Applies to anchors
172
Report Builder Reference
. Bottom.

Parent Object Name
Description The Parent Object Name property is the name of the parent object. Applies to anchors
Report Builder Reference
173
. This field is read-only.

the text line will appear in the Report Editor.Boilerplate properties
Additional Hyperlink Attributes Application Command Line (PDF) Base Printing On Bookmark Comments Contains HTML Tags Display Name Format Trigger Horizontal Elasticity Hyperlink Hyperlink Destination Keep With Anchoring Object Line Stretch with Frame Minimum Widow Lines Name Page Break After Page Break Before Page Protect Print Object On Printer Code After Printer Code Before Source File Format Source Filename Type Vertical Elasticity
Boilerplate restrictions
n n
The maximum size of boilerplate text is 64K of text per paragraph and 64K paragraphs.
Caution: When you resize boilerplate text. ensure the text fits in the object. but.
174
Report Builder Reference
. the line may not appear in the output. If font descends (the space left for the lower parts of letters like g and q) do not fit. Boilerplate must be in front of the repeating frame that contains it. This limit may vary according to your operating system. depending upon the Horizontal and Vertical Elasticity settings. when the report is run.

Report Builder fixes the object both vertically and horizontally. link file boilerplate with a source file format of text.class" width=84 height=72> <param name=text value="10"> </applet>
Report Builder Reference
175
. and formats the object as a normal text object (i.uk.uk.e.com/java/NervousText/> <applet code="NervousText.
ObjectWidth and ObjectHeight output to HTML example
In a boilerplate text object.Contains HTML Tags
Description The Contains HTML Tags property indicates that the boilerplate or field object includes HTML tags. which takes the object width and height as parameters:
<base href=http://cagney.com/java/NervousText/> <applet code="NervousText. and fields with a source datatype of character. If you need to pass the object width and height as parameters. called NervousText. you can type the following Java Applet.. you can use the ObjectWidth and ObjectHeight variables. as shown in the example.oracle.class.oracle.class" width=&ObjectWidth height=&<ObjectHeight>> <param name=text value="&deptno"> </applet>
This is output to HTML as:
<base href=http://cagney. any field references are resolved). Applies to boilerplate and fields Required/Optional optional Default No
Contains HTML Tags restrictions
n
Contains HTML Tags can only be used on text boilerplate.

Minimum Widow Lines
Description The Minimum Widow Lines property is the minimum number of lines of the boilerplate or field text that should appear on the logical page where the object starts to print. you can avoid having one line of a field at the bottom of the logical page by itself. you might get a situation like the one shown in the figure. Values Any whole. then all lines of text are moved to the next page. Applies to boilerplate and fields Required/Optional optional Default 0 (the text that can fit on the logical page should be printed before continuing on the next page)
Minimum Widow Lines restrictions
n
Minimum Widow Lines can only be used on text boilerplate. Note: This property applies only to the initial lines of text in the boilerplate or field object. where the first line of the field is printed at the bottom of a logical page and the rest is printed on the next logical page. See the online help for details and illustrations. link file boilerplate with a source file format of text.
176
Report Builder Reference
. 2)
With Minimum Widow Lines set to 1.
Minimum Widow Lines example (set to 1 vs. It does not provide widow protection for individual paragraphs. positive number from 0 through 32K. If the number of lines specified for this property cannot fit on the logical page. as shown in the second figure. With Minimum Widow Lines set to 2 (or more). and fields with a source datatype of character.

Source File Format
Description The Source File Format property is the format of the external file to which the boilerplate is linked.0. If you are planning to open/run the report in Version 2. Applies to external boilerplate Required/Optional required
Report Builder Reference
177
. select the specific image format of the boilerplate. Values Text Is text in ASCII format Image Is a bitmapped image CGM Is a line drawing in CGM format Oracle Drawing Format Is a line drawing in Oracle format Image URL Is a URL link to an image Note: All the other image formats are provided in case you want to open the report in Oracle Reports Version 2. you can choose from the above choices. If not.0.

This prevents the need to hardcode directory paths in your report. Values Enter a valid filename or image URL not to exceed 1K in length. you may need to update the filename. You can also include files in your report using Read from File. You can prefix a path to the filename. and PL/SQL). Applies to external boilerplate Required/Optional optional Default blank Usage Notes
n
To ensure the portability of your reports. The source filename may be operating-system dependent. external queries. you can take advantage of the Report Builder-specific environment variable called REPORTS30_PATH.
178
Report Builder Reference
. but cannot be edited within the Report Editor. Linking to a file is useful for including the contents of files that are likely to change.Source Filename
Description The Source Filename property is the name of the external file or image URL to which the boilerplate is linked. The boilerplate is automatically updated to reflect the latest contents of the file when you do any of the following:
n n n n n
accept the property sheet paste the object import the object (if it’s in Oracle Format) open the report run the report
The contents of a file linked to a boilerplate object will appear in the Report Editor. You can use this variable to specify the default directory or directories where you want Report Builder to search for external files you use in your reports (e..
n
Source Filename restrictions
n n
The maximum size of the file you specify depends upon your operating system.g. Report Builder uses its file path search order to find the file. boilerplate. If a path is not prefixed to the filename. If you move the report to another operating system.

e. the properties of the object will be ignored). If you want the object’s properties to be used.e.n n
This field appears only for objects created with the Link File tool.. If you specify a file that contains a layout object and its properties (i.
Report Builder Reference
179
.. the file is treated as an anonymous graphical object (i. then you should import it instead of linking the file. a file that contains an exported layout object).

g..Type
Description The Type property is the format (e. text) of the boilerplate object. This field is read-only. Applies to boilerplate
180
Report Builder Reference
.

the left endpoint is anchored to the left side of the frame and the right endpoint is anchored to the right side of the frame. you would edit the layout as follows:
n n n n
Expand the innermost group frame (GF2) and detail repeating frame (RF2) to enclose the two group fields. Null means the property is not set.
See the online help for details and illustrations. Create boilerplate line L1 under the fields in the detail repeating frame (RF2). the top endpoint is anchored to the top of the frame and the bottom endpoint is anchored to the bottom of the frame. When set. If the line is vertical. and the boilerplate line will remain fixed in size when the report is formatted. and Line Stretch with Frame. so that all the fields are enclosed in the detail repeating frame. this property anchors the line at both endpoints to the associated frame. the line must be enclosed completely within the repeating frame.Line Stretch with Frame
Description The Line Stretch with Frame property is the name of the frame or repeating frame to which the boilerplate line is associated. See the online help for details and illustrations. Thus. the line stretches the same amount as the associated frame stretches when the report is formatted. Using anchors.
Line Stretch with Frame example (grid)
Suppose you want to separate the rows and columns of a group left report with a grid. Applies to boilerplate lines Required/Optional optional Default Null Usage Notes
n
n
Line Stretch with Frame can be set for any boilerplate line. Values Select a frame or repeating frame from the list of those currently in the report.
Report Builder Reference
181
. Create boilerplate lines L2 through L5 and associate them with the surrounding group frame (GF1) using Line Stretch with Frame. regardless of its position in the layout. Anchor each of the group fields to the master repeating frame (RF1). If you use this property to associate a line with a repeating frame. If the line is horizontal. boilerplate lines.

and lines L2 through L5 stretch to cover the whole length of the outermost group frame.
182
Report Builder Reference
. the explicit anchors cause the group fields to appear at the same frequency as the master repeating frame. the implicit anchoring algorithm does not apply.
Line Stretch with Frame restrictions
n n
Line Stretch with Frame supports only vertical and horizontal lines.When the report is formatted. If set for a diagonal line. it becomes a vertical or horizontal line when formatted. Line L1 repeats for each record in the detail repeating frame. When this property is set.

.Button properties
Additional Hyperlink Attributes Application Command Line (PDF) Base Printing On Bookmark Comments Format Trigger Horizontal Elasticity Hyperlink Hyperlink Destination Icon Name Keep With Anchoring Object Label Type Multimedia Column Multimedia Column Type Multimedia File Multimedia File Type Name Page Break After Page Break Before Page Protect PL/SQL Trigger Print Object On Printer Code After Printer Code Before Text Type Vertical Elasticity
Button restrictions
n n
Buttons do not appear in printed output.
Report Builder Reference
183
. Changing the border to a dashed line appears in the Layout Model view but not the Live Previewer view. They also do not appear when reports containing them are run in character mode. Buttons appear in the Live Previewer view with the characteristics of native buttons on your platform. Therefore. changing borders to dashed lines) may not appear in your output.g. changes made in the Layout Model view that affect the appearance of the button (e.

it will appear above the objects within the repeating frame in the Live Previewer view. for example. However.
n A button is always be displayed on the uppermost layer of objects in the Live Previewer view. it may not truly be on the top layer of the Layout Model view. if it is covered by a repeating frame in the Layout Model view. but will not repeat with the repeating frame.
184
Report Builder Reference
.n n
The ability to assign different colors and patterns to user-defined buttons is platformspecific. You cannot rotate a button.

Icon Means that you want to use an icon as the button label. Applies to buttons Required/Optional required Default Text
Label Type restrictions
n
An icon used as a label should be in the standard icon format of your platform. Use the Icon Name property to specify the name of the file containing the icon for the label (the file must reside in the directory specified by the TK25_ICON environment varialble). with an extension of . Values Text Means that you want to use a text string as the button label. Use the Text property to enter the text string for the label.Label Type
Description The Label Type property is the type of identifier you want to appear on the button.
Report Builder Reference
185
. Icons are not portable.ico.

practical length is governed by the size of the button. such as Spacing and Justification.
186
Report Builder Reference
. but will be clipped on both the left and the right. Values Any text string up to 2K in length. certain menu choices do not affect button text.
Text restrictions
n
If the text does not fit on the button.Text
Description The Text property is the text label that will appear on the button if you selected Text for the Label Type. However. The specified text string is center-justified both horizontally and vertically on the button. and style of the label text using some of the choices on the Format menu. however. size. Applies to buttons Required/Optional optional Default blank Usage Notes
n
You can change the font. it will not wrap to a second line. weight.

with an extension of .ico. Values Any valid icon file in the standard icon format of your platform. Applies to buttons Required/Optional optional Default blank
Report Builder Reference
187
. The file must reside in the directory specified by the TK25_ICON environment varialble.Icon Name
Description The Icon Name property is the name of the file containing the icon that will appear on the button if you selected Icon for the Label Type.

n
188
Report Builder Reference
.PROGRAM_ABORT in the button’s action trigger. Values Multimedia File Means that the action is contained in a file in your operating system. it will close any Previewer window that was raised by the button. you must specify PARAMFORM=YES in the call to SRW.RUN_REPORT. PL/SQL Means that the action is governed by a PL/SQL program unit associated with the button. specified by the Multimedia File property. If you want the Runtime Parameter Form to appear. If you specify PL/SQL Trigger and you raise SRW. the Runtime Parameter Form will not appear by default when the button is selected. specified by the PL/SQL Trigger property. Multimedia Column Means that the action is contained in a database column. Applies to buttons Required/Optional required Default Multimedia File
Type restrictions
n
If you specify PL/SQL Trigger and your PL/SQL uses SRW.Type
Description The Type property is the action to be performed when the button is pressed. specified by the Multimedia Column property.RUN_REPORT.

You can use this variable to specify the default directory or directories where you want Report Builder to search for external files you use in your reports (e.g. video. Values Any valid sound. If you do not give a path for a file. Report Builder uses its file path search order to find the file. boilerplate.. or image file. and PL/SQL). external queries. This prevents the need to hardcode directory paths in your report.Multimedia File
Description The Multimedia File property is the name of the multimedia (sound. Applies to buttons Required/Optional Required. Default blank Usage Notes
n
To ensure the portability of your reports.
Report Builder Reference
189
. if Type is Multimedia File. or image) file.
Multimedia File restrictions
n
If you select Multimedia File. video. you can take advantage of the Report Builder-specific environment variable called REPORTS30_PATH. you must indicate the filename in the text field provided.

if Type is Multimedia Column. video. select an image column. you must choose another column before you can accept the property sheet. and Multimedia Column becomes undefined. or image) object. If the button’s property sheet is open at the time the Multimedia Column becomes undefined. Values Any valid database column in the report containing a multimedia object. If the property sheet is closed at the time the Multimedia Column becomes undefined. your button no longer has access to data to display. An error will result. specify it as the Multimedia Column for a button. you will not be alerted until you run the report and try to activate the button.Multimedia Column
Description The Multimedia Column property is the name of a database column in the report that contains a multimedia (sound.e.
Report Builder Reference
191
. Applies to buttons Required/Optional Required.. Default blank
Multimedia Column restrictions
n
If you specify a Multimedia Column for the action of a button and later delete that column from your report (i. and later delete that column or change its format to a nonmultimedia format).

PL/SQL Trigger
Description The PL/SQL Trigger property is a PL/SQL procedure that is executed when a button is selected in the Live Previewer view. The trigger can be used to dynamically call another report (drill down) or execute any other PL/SQL. Applies to buttons Required/Optional Required. if the button Type is PL/SQL Default blank
Report Builder Reference
193
.

This means that the bar chart will appear once for each department. You then go to the Property Palette for the chart object and set the Display Name property to empsal.ogd) that shows a bar chart of salaries for each employee and you would like to include it in your report. In Graphics Builder. no path was specified because we want Report Builder to use the path specified for the REPORTS60_PATH environment variable. you first draw a chart object inside the repeating frame for the master repeating frame (R_Dept). Using the Chart tool in the Layout Model view. You then set properties in the Property Palette as follows: G_Emp Source Q_OG_Emp Display Query ENAME/OG_NAME Report Column/Display SAL/OG_SALARY
194
Report Builder Reference
. you have created a Graphics Builder display (empsal.ogd. but in this case. Display Name can optionally contain a path.Chart properties
Additional Hyperlink Attributes Application Command Line (PDF) Base Printing On Bookmark Chart Filename Chart Hyperlink Comments Format Trigger Horizontal Elasticity Hyperlink Hyperlink Destination Keep With Anchoring Object Name Page Break After Page Break Before Page Protect Parameters and Columns Print Object On Printer Code After Printer Code Before Vertical Elasticity
Chart in a group report example
Suppose that you have a group report with the following data model: See the online help.

then it must appear inside the repeating frame(s) of it’s source group’s ancestors (if any). a group within a crossproduct group). If a column being passed is a summary owned by a cross-product group. If a Graphics Builder display/chart source group is a dimension group (i.
n
Report Builder Reference
195
.. You must enter the names of the display columns that correspond to ENAME and SAL in Display Column. SAL OG_SALARY FROM EMP Since you specified Q_OG_Emp for Display Query.)
Chart restrictions
n
A Graphics Builder display/chart that passes data can be placed anywhere in the Layout Model view unless its source group is a dimension of a matrix. then the Graphics Builder display/chart must be placed inside of the set of repeating frames whose sources are the groups in the summary column’sProduct Order. You select ENAME and SAL from the list under Report Column. (Display Column cannot be blank if Report Column is specified. A Graphics Builder display/chart that passes parameters must be placed inside of a repeating frame whose source group is the group (or a descendant of the group) that contains the columns or parameters it is passing. Display Query is the name of a query in the display.e.Column Source is the group (G_Emp) that is summarized by the display. Q_OG_Emp contains the following SELECT statement: SELECT ENAME OG_NAME. this query will retrieve the values of ENAME and SAL from Report Builder instead of the database. Report Column and Display Column map the report’s columns to the display’s columns.

Chart Filename restrictions
n
You can only reference displays/charts stored in files. To ensure the portability of your reports.g. you can take advantage of the Report Builder-specific environment variable called REPORTS60_PATH. This prevents the need to hardcode directory paths in your report. external queries.ogd extension is optional). those stored in the database cannot be referenced in Chart Filename. You can use this variable to specify the default directory or directories where you want Report Builder to search for external files you use in your reports (e. Values Enter any valid filename (not to exceed 512 bytes in length) of a Graphics Builder display/chart (the . If a path is not prefixed to the filename. and PL/SQL).
196
Report Builder Reference
. Report Builder uses its file path search order to find the file..Chart Filename
Description The Chart Filename property is the name of the file in which the Graphics Builder display/chart is located. Applies to chart objects Required/Optional required Default blank Usage Notes
n n
You can optionally prefix a path to the filename. boilerplate.

See d2kcfg.
Report Builder Reference
197
. Note Values Any object in your report output. n You cannot set this property using PL/SQL since the format trigger is executed only once for the chart. Instead. or any valid hyperlink destination Applies to chart objects Required/Optional optional Default blank Usage notes
n You must specify the Hyperlink Destination property if you want to set a Chart Hyperlink property for a chart that specifies another object as its destination. you can specify &<column_name> as the Chart Hyperlink property. n You can set another report as the Chart Hyperlink property by running the second report from your report output.htm in your ORACLE_HOME for more information. n You cannot use the Additional hyperlink attributes property to apply additional HTML attributes to a link defined by the Chart Hyperlink property.Chart Hyperlink
Description The Chart Hyperlink property is a hyperlink that you can specify to be different for each chart section. another report.

Note: One report column or parameter can correspond to multiple chart parameters. parm1. You can also enter a list of valid parameter names in your Graphics Builder display/chart.g. Applies to chart objects Required/Optional optional Default Report Builder parameter name
Report Builder Reference
199
. Values Enter the name (not to exceed 1K in length) of a valid parameter in your Graphics Builder display/chart. but each chart parameter can only correspond to one report column or parameter. separating each one with a comma (e.parm2.Chart Parameter
Description The Chart Parameter property is a parameter in the Graphics Builder display/chart that corresponds to the column or parameter specified in Report Column.parm3).

Report Column (for Chart Parameter)
Description The Report Column (for Chart Parameter) property is a list of the columns and parameters in your report that could be used to supply the value of a parameter in a Graphics Builder display/chart. If the parameter in the display/chart has a different name than the column or parameter in the report.e. Applies to chart objects Required/Optional optional Default deselected
Report Column (for Chart Parameter) restrictions
n
A page-level summary column (i. Values Select one or more valid columns or parameters in your report. a summary with a Reset At or Compute At of Page) cannot be passed to a Graphics Builder display/chart. Similarly. you must specify its name in the corresponding Chart Parameter field. Selecting a column or parameter means that there is a corresponding parameter in the display/chart and that the display/chart parameter will get its value from the selected report column or parameter.
200
Report Builder Reference
. any summary or formula column that depends upon a page-level summary cannot be passed to a display/chart..

Note: If you specify a query name here. Values Enter any valid query name (not to exceed 512 bytes in length) of the Graphics Builder display/chart specified in Chart Filename. Applies to chart objects Required/Optional optional
Report Builder Reference
201
. Chart Query ensures that the data used in the display/chart is the same as the data in the report. you must also specify which report columns or parameters should have their values used by the display/chart query. that query will retrieve its records through Report Builder instead of the database. This enables your display/chart to reflect any filtering or summarizing that your report performs on the data. If you specify a query name.Chart Query
Description The Chart Query property is the name of the query in the Graphics Builder display/chart that should get its records from Report Builder.

Report Group restrictions
n n n
You cannot specify a cross-product group for Report Group. Applies to chart objects Required/Optional Required. the Report Group is deselected when you accept the property sheet. Any columns that you pass to the Graphics Builder display/chart via Report Column (for Chart Column) must be in the report group or its ancestor. if value entered for Chart Query. If you select a Report Group but not a Chart Query. Values Select any group name from the list of values.Report Group
Description The Report Group property is the group in the report that is summarized by the Graphics Builder display/chart.
202
Report Builder Reference
.

Note: One report column or parameter can correspond to multiple chart columns.Chart Column
Description The Chart Column property is a column or list of columns in the Graphics Builder display/chart that corresponds to the column or parameter specified in Report Column. col1. Values Enter the name (not to exceed 1K in length) of a valid column in your Graphics Builder display/chart.col2. separating each one with a comma (e.g.col3). but each chart column can only correspond to one report column or parameter. Applies to chart objects Required/Optional optional Default Report Builder column name
Report Builder Reference
203
. You can also enter a list of valid column names in your Graphics Builder display/chart.

Selecting a column or parameter means that there is a corresponding column(s) in the Graphics Builder display/chart and that the display/chart column(s) will get its value from the selected report column or parameter. Values Select one or more valid columns or parameters in your report. if value entered for Chart Query. any summary or formula column that depends upon a page-level summary cannot be passed to a Graphics Builder display/chart. a summary with a Reset At or Compute At of Page) cannot be passed to a Graphics Builder display/chart. you must specify its name in the corresponding Chart Column field. A page-level summary column (i. Applies to chart objects Required/Optional Required.
Report Column (for Chart Column) restrictions
n n
Any columns that you pass to the Graphics Builder display/chart via Report Column (for Chart Column) must be in the Report Group or its ancestor. If the column(s) in the display/chart has a different name than the column or parameter in the report. Similarly.Report Column (for Chart Column)
Description The Report Column (for Chart Column) property is a list of the columns and parameters in your report that could be used by the query specified in Chart Query.e.
204
Report Builder Reference
..

In the query. SAL FROM EMP ORDER BY SAL
You then create two groups. The output would appear similar to that below:
206
Report Builder Reference
.00 CLERK SMITH 800. The order of column values in a default group is determined by the ORDER BY clause of the query.Break Order
Description The Break Order property is the order in which to display the column’s values. G_DEPT and G_JOB. ENAME.00 ADAMS 1100. JOB. You have also specified a Break Order of Descending for the DEPTNO column.. however. you must use Break Order to specify how to order the break column’s values. If you specify a Break Order of Descending for the DEPTNO column and Ascending for the JOB column. For column values in user-created groups.00 20 ANALYST SCOTT 3000. Default Ascending
Break Order example (descending)
Suppose that you create a report with the following query:
SELECT DEPTNO.00 MANAGER BLAKE 2850.00
Break Order example (ORDER BY)
Suppose that you created a Group Left report with DEPTNO and ENAME.00 MANAGER JONES 2975.00 10 CLERK MILLER 1300.00 TURNER 1500. G_DEPT contains the DEPTNO column and G_JOB contains the JOB column.00 PRESIDENT KING 5000.00 MARTIN 1250.e. you have ORDER BY DEPTNO.-----------------30 CLERK JAMES 950. Values Ascending Descending Applies to columns Required/Optional Required.00 SALESMAN WARD 1250.00 FORD 3000. break groups).00 ALLEN 1600. if Set Break Order is set to Yes. This property applies only to columns that identify distinct values of user-created groups (i. your output would appear similar to that below (assuming you use a Tabular style): Deptno Job Ename Sal --------------.00 MANAGER CLARK 2450.

n Every group above the lowest child group of a query must have at least one column with Break Order set. then department numbers are printed in ascending order. but the names within each department print in the order specified by the query.
Break Order restrictions
n Break Order has no effect on columns that belong to the lowest group of a particular query.) n A summary column cannot be a break column and cannot have Break Order set. the department numbers are in descending order).Deptno -----30
Ename ---------JAMES WARD MARTIN TURNER ALLEN BLAKE 20 SMITH ADAMS JONES SCOTT FORD 10 MILLER CLARK KING Notice that the Break Order property takes precedence over the ORDER BY clause (i. n Break Order only affects the ordering of the column on which you are breaking. For example. n Break Order cannot be specified for columns of Datatype Long or Long Raw.
Report Builder Reference
207
. n A formula column that depends upon a summary column cannot be a break column and cannot have Break Order set. suppose that you break on DEPTNO and for each department you list ENAME. If the Break Order is Ascending.e. (You would need to use an ORDER BY clause in your SELECT statement to change their ordering. It does not affect the ordering of the columns within the break group.. Break Order only effects columns in groups that are above the lowest child group of a query.

Applies to columns Required/Optional optional Default blank
Report Builder Reference
209
.Comment
Description The Comment property is a text field in which you can document the column. Values Enter any text not to exceed 64K.

CITY. Applies to columns Required/Optional required
210
Report Builder Reference
. For example. suppose that you have a column object named ADDRESS that contains a column object named COUNTRY that contains a column named CITY.COUNTRY.Database Column Name
Description The Database Column Name property is the full name of the column used by the Oracle server to identify the column. The Database Column Name for CITY would be ADDRESS.

Datatype
Description The Datatype property is the type of the column’s contents. Values Character Date Long Long Raw Number Raw Varchar Varchar2 Trusted Oracle datatypes (MLSLABEL and ROWLABEL) are supported by Report Builder. When running on an operating system with Trusted Oracle, Report Builder treats these columns as Trusted Oracle datatypes. This means that the columns can be properly sorted. When running on an operating system without Trusted Oracle (e.g., Windows), Report Builder treats these columns as character datatypes. Applies to columns Required/Optional required Default For database columns, the default Datatype is derived from the database. For summary columns with a Function of Count, the default Datatype is Number. For other summary columns, the default is derived from Source. For formula and placeholder columns, the default Datatype is Number.

Datatype restrictions
n You can only edit the Datatype of a formula or placeholder column. For formula and placeholder columns, you can set the Datatype to Character, Date, and Number. n A column of Datatype Long, Long Raw, or Raw is treated as text unless you specify otherwise in the File Format field. n If a column has an alias and you change your query, causing the datatype of the column to change, the change in datatype will be automatically reflected in Datatype when you accept the query.

Report Builder Reference

211

File Format
Description The File Format property is the format of the object being retrieved from the database or identified by the filename stored in the column. Value Text Is text in ASCII format Image Is a bitmapped image CGM Is a line drawing in CGM format Oracle Format Is a line drawing in Oracle format (Drawing) Sound Is a sound object in longraw format Video Is a video object in longraw format OLE2 Is a linked object to be embedded in your report Image URL Is a URL link to an image Applies to columns

212

Report Builder Reference

Name
Description The Name property is the name Report Builder uses to identify the current column. Enter any valid column name not to exceed 30 bytes. Applies to columns Required/Optional required Default For a database column, the name as referenced in the SELECT list of the SELECT statement. For a summary column, CS_n, where n is a number that is unique among summary names for the report. For a formula column, CF_n, where n is a number that is unique among formula names for the report. For a placeholder column, CP_n, where n is a number that is unique among placeholder names for the report.

Name restrictions
n Name is only editable for summary, formula, and placeholder columns. n Report Builder uses the column name, alias, or text of the expression from the query as the default name for a database column.

Report Builder Reference

213

Read from File
Description The Read from File property indicates that the column contains the names of files or a URL for an image. When you set Read from File to Yes, you must specify the format of the files in the File Format property. Read from File is useful if you have image, graphic, or text files that are referenced by a column. If you set Read from File to Yes, the contents of the files will be imported and used as the values of the column. If Read from File is set to No, the column will get its values from the database. As a result, if a column contains filenames and Read from File is set to No, the filenames will be printed instead of the file contents. You can use Read from File with database, summary, formula, or placeholder columns (assuming that the column’s values are filenames). You can also include files in your report as boilerplate. Applies to columns Required/Optional optional Usage Notes

n

You can prefix paths to the filenames in the column. If a path is not prefixed to the filename, Report Builder uses its file path search order to find the file.

n To ensure the portability of your reports, you can take advantage of the Report Builder-specific environment variable called REPORTS60_PATH. You can use this variable to specify the default directory or directories where you want Report Builder to search for external files you use in your reports (e.g., external queries, boilerplate, and PL/SQL). This prevents the need to hardcode directory paths in your report.

Read from File example (image)
Suppose that for each of your employees you have a .bmp file that contains a picture of the employee. In your employee table, you have a column named PICTURE that contains the name of the .bmp file with the employee’s picture. To generate a report that displays the employees’ pictures, you select the PICTURE column in your query. On the Column property sheet for the PICTURE column, you set Read from File to Yes and specify Image as the File Format. Report Builder will display the files pointed to by the PICTURE column wherever you have referenced the PICTURE column in your layout. Note: If Read from File is set to No, the filenames will be printed instead of the pictures.

Read from File example (formula column)
Suppose that you want to create an employee listing with some text from a file next to each employee’s information. If the employee’s salary is greater than $2000 you want text from a file called salary1.txt to appear next to the employee. If the employee’s salary is

214

Report Builder Reference

less than $2000 you want the text from a file called salary2.txt to appear next to the employee. You create a formula column with a Datatype of Character and Read from File set to Yes (with a File Format of Text). In the Formula field for the column, you enter the following PL/SQL:
if :sal > 2000 then return(’/home/jsmith/txt/salary1.txt’); else return(’/home/jsmith/txt/salary2.txt’); end if;

Read from File restrictions
n The size of each file may be at most 4 gigabytes. (On some operating systems the file may be at most 64K.) n Read from File may only be set to Yes if the Datatype of the column is charactercompatible (i.e., Character, VARCHAR, or VARCHAR2). n If you set Read from File to Yes on a summary or formula column, the summary or formula is calculated before the file is read. Similarly, for placeholder columns with Read from File set to Yes, the column’s value is calculated first.

Report Builder Reference

215

Value If Null
Description The Value if Null property is a value to be substituted for any null values of the column. For example, if you enter X in this field, then an X will be displayed for null values fetched for the column. If left blank, no substitution will be done for null values. Values Enter any valid value that conforms to the column’s Datatype. Value if Null cannot exceed 1K in length. Applies to columns Required/Optional optional Default blank Usage Notes

n Entering a string for Value if Null on a break column causes Report Builder to prefetch all of the rows in the break column’s group. This could degrade performance when you run the report. To avoid prefetching, use the NVL function in your query rather than entering a string for Value if Null.

Value If Null restrictions
n For columns with a character datatype (e.g., VARCHAR), if the width of the string you enter for Value if Null exceeds the Width of the column, the string is truncated. n If a column is referenced via a lexical reference in a query, that column’s Value if Null is used to validate the query. n The value entered for Value If Null must be the same datatype as the column. For example, if the column’s Datatype is Number, you cannot specify "XX" in Value If Null, you must specify a number. n If you enter a date value in Value If Null, it is validated against Report Builder’ internal mask for dates (i.e., DD-MON-YY). (Number and character values are not validated.)

216

Report Builder Reference

Width
Description The Width property is the maximum number of characters that the values of the column can occupy. This Width refers to the width that Report Builder uses internally for the column. It effects such things as the calculation of summaries and formulas. The size used to display the column’s data, however, is determined by the size of the associated field in the Layout Model view and its Vertical and Horizontal Elasticity properties. Values Enter any number from 1 through 64K. Enter two numbers in the form a,b where a indicates the number of digits to the left of the decimal point and b indicates the number of digits to the right of the decimal point. (This form can only be used for defining the width of numbers.) Applies to columns Required/Optional required Default For database columns, the default Width is derived from the database. For summary and formula columns, the default for Width is 10, 0. If a column has a Type of Summary, Report Builder updates the Width based upon what you enter as the column’s Source and Function. Usage Notes

n If the Column Type is Database Scalar and the Datatype is Character, Date, Number, or Raw, Width is uneditable. However, this does not mean you cannot control the width of the column’s values in the report output. You can change the width of the values in the output by modifying the field’s width in the Default Layout dialog box or the Field property sheet. n If the Column Type is Database Scalar or Placeholder and the Datatype is Long or Long Raw, you can enter a value in Width. Note that if you do not specify a width for a Long or Long Raw column, Report Builder allocates the maximum width for the column. You can also enter a Width for a column of Type Formula. n If the Column Type is Database Ref, Width is uneditable.

Width restrictions
Caution: If the value of a column of Type Database and Datatype Long or Long Raw exceeds the Width of the column, the value is truncated.

n If the value of a column of Type Placeholder or Formula exceeds the Width of the column, an exception is raised. n If a column has an alias and you change your query, causing the width of the column to change, the change in width will be automatically reflected in Width when you

Report Builder Reference

217

accept the query.

218

Report Builder Reference

Set Break Order
Description The Set Break Order property is whether to set the order in which to display the column’s values, using the Break Order property. Applies to columns Required/Optional optional Default Yes

Common Layout Object restrictions
n You must ensure that properties on the same or different objects do not conflict with each other. Because of the power of the layout properties, it is possible to specify properties such that they conflict with other properties. You should avoid the following combinations of layout properties on the same object. If you try to use these combinations on the same object, you will get an error: n Base Printing On of Enclosing and Print Object On of Last Page n Base Printing On of Enclosing and Print Object On of All But Last Page n Print Object On of All Pages and Page Break Before set to Yes n Print Object On of All But First Page and Page Break Before set to Yes n Print Object On of All But Last Page and Page Break Before set to Yes n Keep With Anchoring Object and Page Break Before set to Yes (for an object that is located after its anchoring object) or Page Break After set to Yes (for an object that is located before its anchoring object)

220

Report Builder Reference

n Similarly, combinations of properties on different objects can cause unpredictable results or an infinite report. For example, suppose you have two boilerplate objects anchored together inside of a frame. The parent object has a Print Object On of All Pages and a Base Printing On of Enclosing. The child object has a Print Object On of First Page, a Base Printing On of Anchoring, and Page Break Before set to Yes. The figure below illustrates this layout. When you run the report, the child object does not appear in the output. Because it has Page Break Before set to Yes, the child can never satisfy its Print Object On (First Page) and it’s Base Printing On (Anchoring). Note, however, that the object underneath the child object (B_Plate3) does appear.
See the online help for details and illustrations.

Report Builder Reference

221

Comments
Description The Comments property contains a text field in which you can document the object. Enter any text not to exceed 64K. Applies to objects Required/Optional optional Default blank

222

Report Builder Reference

do not contract. and chart objects determine the scaling factor. Report Builder uses proportional scaling. n For images. elasticity defines whether the size of the frame or repeating frame should vary with the objects inside of it. look at the examples. (You can think of this option as meaning "only expand.") Fixed Means the width of the object is the same on each logical page. The width of the object is defined to be its width in the Report Editor. do not expand. if the formatted objects or data within it are wide enough. but it cannot decrease to a width less than that shown in the Report Editor.Horizontal Elasticity
Description The Horizontal Elasticity property is how the horizontal size of the object will change at runtime to accommodate the objects or data within it:
n For frames and repeating frames. regardless of the size of the objects or data within it. drawings. Number or date data will appear as asterisks if the data cannot fit within the defined size. elasticity defines whether the field or boilerplate should vary with the size of the text. look at the examples. drawings. The elasticity options for images. which means the width shown in the Report Editor has no effect on the object’s width at runtime. Applies to layout objects Required/Optional required Default varies according to the object Usage Notes
n If you create a Graphics object in your report with a Vertical and Horizontal Elasticity of Fixed. (You can think of this option as meaning "only contract. Truncation of data may occur.") Expand Means the horizontal size of the object increases. and chart objects.
See the online help for details and illustrations. Truncation of data may occur. but it cannot increase to a width greater than that shown in the Report Editor. Values Contract Means the horizontal size of the object decreases. Variable Means the object may expand or contract horizontally to accommodate the objects or data within it (with no extra space). Report Builder scales the display to fit within the dimensions
Report Builder Reference
223
. Fixed size text will wrap within the defined size of the object and may be truncated if there is not enough room. if the formatted objects or data within it are wide enough. n For objects containing text.

The following diagram shows how the frame might be formatted: See the online help for details and illustrations. because there is not enough room on the first logical page.
Horizontal Elasticity example (frame)
Suppose that you have a frame named M_1 with the following characteristics: Characteristic Value Horizontal Variable Elasticity height 7 inches Vertical Elasticity Fixed Assume further that the Page Width you defined in the report property sheet is eight inches. the second two instances.
Horizontal Elasticity example (field)
Suppose that you have a field with the following characteristics: Characteristic Value width 1 inch Horizontal Contract Elasticity height 1 inch Vertical Elasticity Fixed See the online help for details and illustrations. and the last is four inches. It is also important to note here that if the data was more than one inch long. F_Ename. Note that the first two instances of field F_Ename print on the first logical page. instead of Variable. Note that when the data is less than one inch wide the size of the field decreases to the minimum size necessary to hold the data. the frame would not print unless it could fit entirely on one logical page. print on the second logical page. it would be truncated because the field cannot expand vertically or horizontally. the next value is 3 inches. It is also important to note that if the Horizontal Elasticity was Contract or Fixed.
224
Report Builder Reference
. the next is four inches. M_1 contains a repeating frame with one field. The first value of F_Ename is four inches wide.you defined for the object. but.

they will be moved to the next logical page. or both cannot fit on the logical page. Since B_2 also has Keep With Anchoring Object set to Yes and its anchoring object is B_1. This prevents unnecessary blank pages in your report. Otherwise. it means the first instance of the repeating frame must be able to fit on the same page as its anchoring object.g. B_2 and B_3 would be moved to the next logical page. it means the object must be able to format entirely on the same page as its anchoring object. B_2 and B_3 each has Keep With Anchoring Object set to Yes. there is enough room for B_1 and B_2 but not for B_3. its anchoring object. Applies to layout objects Required/Optional optional Default No
Keep With Anchoring Object example
Suppose that you have created three boilerplate objects: See the online help for details and illustrations. Keep With Anchoring Object may have an effect even if you have not explicitly created an anchor between two objects. Consequently. If you set Keep with Anchoring Object to Yes for a repeating frame.
Report Builder Reference
225
. If you set Keep With Anchoring Object to Yes for any layout object other than a repeating frame. The anchor between the two objects may be explicit or implicit. then anchoring object refers to the repeating frame as a whole (all the instances of the repeating frame). n If the anchoring object is a repeating frame and the current object is outside of the repeating frame. Keep With Anchoring Object is ignored on subsequent pages. n If moving the object and its anchoring object to the next logical page would leave the current logical page blank or only containing repeated objects (e. On the logical page where Report Builder first tries to print these objects.Keep With Anchoring Object
Description The Keep with Anchoring Object property indicates whether to keep an object and the object to which it is anchored on the same logical page.
Keep With Anchoring Object restrictions
n Keep With Anchoring Object applies only to the first logical page on which the object is triggered to be formatted. B_1 would also be moved to the next logical page. Since B_3 has Keep With Anchoring Object set to Yes and its anchoring object is B_2. the Keep With Anchoring Object condition is not satisfied. Keep With Anchoring Object will not be applied.. Setting Keep with Anchoring Object to Yes means that if the object. a page heading).

then this rule applies to each instance of the repeating frame. and M_1 would all have to be able to complete formatting on the same page in order to satisfy the Keep With Anchoring Object condition.
See the online help for details and illustrations. If the two objects are enclosed by a repeating frame instead of a frame. B_1. In the figure. then all three objects must be able to complete formatting on the same page to satisfy the Keep With Anchoring Object condition.n If two objects are anchored to their enclosing frame and the frame has Vertical and/or Horizontal Elasticity of Contract or Variable. B_2.
226
Report Builder Reference
.

If the group is not associated with a query (i. where n is a number that is unique among field names for the report. fields F_n. where n is a number that is unique among OLE2 object names for the report.Name
Description The Name property is the name that Report Builder uses to identify the current object. the default group name is also G_n. groups G_queryname. formula columns CF_n. where queryname is the query’s name and a number that is unique among groups.e. where n is a number that is unique among matrix names for the report. parameters P_n. where n is a number that is unique among formula names for the report. where n is a number that is unique among placeholder names for the report. queries Q_n. where n is a number that is unique among frame names for the report.. Enter any valid name not to exceed 30 bytes. where n is a number that is unique among Graphics object names for the report.g. the name that you used in the query is the default. the default group name is of the form: G_n. where n is a number that is unique among group names for the report. OLE2 objects B_n. chart objects D_n. where n is a number that is unique among query names for the report. frames M_n. Applies to objects Required/Optional required Default boilerplate B_n. button objects U_n. where n is a number that is unique among field names for the report. placeholder columns CP_n. matrix objects X_n. If you create a parameter by making a bind reference in your query. Q_1). a cross product group). database columns the column name as referenced in the SELECT statement of the SQL query (display only). If the query has a default name (e.. where n is a number that is unique among boilerplate object names for the report. where n is a number that is unique among column names for the report.
Report Builder Reference
227
.

repeating frames summary columns
R_n. CS_n. where n is a number that is unique among summary names for the report. where n is a number that is unique among repeating frame names for the report.
228
Report Builder Reference
.

The formatting of sibling objects is not delayed because there is no hierarchy (i. Note that this does not necessarily mean that all the objects below the object with Page Break After will move to the next page. an object must be anchored (implicitly or explicitly) to another object as the parent for Page Break After to have an effect.e. then that object. If an object is not a child of the object with Page Break After set to Yes. then Page Break After has no effect. In other words.. See the online help for details and illustrations. n If an object has no external objects anchored to it (implicitly or explicitly). if it can fit.Page Break After
Description The Page Break After property indicates that you want all children of the object to be moved to the next page. To have a page break after each instance of the repeating frame you should also set Maximum Records per Page to 1 on the repeating frame’s property sheet. See the online help for details and illustrations. may print on the same page as the object with Page Break After set to Yes. any object that is a child object of an anchor (implicit or explicit) to this object will be treated as if it has Page Break Before set to Yes. Page Break After sets a logical page break after the repeating frame as a whole.
Report Builder Reference
229
. As a result. Applies to layout objects Required/Optional optional Default No
Page Break After restrictions
n Page Break After delays only the formatting of an object’s child objects. parent-child relationship) by which Report Builder can determine the order of formatting for siblings. n For repeating frames. n Objects below an object with Page Break After set to Yes may not move to the next page.

you should also set Maximum Records per Page to 1 on the repeating frame’s property sheet. if there is sufficient room. If an object is set to print on a page but is moved to the next page because of Page Break Before. To have a page break before each instance of the repeating frame. Note that this does not necessarily mean that all the objects below the object with Page Break Before will move to the next page.
230
Report Builder Reference
. other objects may be placed in the space where the object was originally set to print. See the online help for details and illustrations. n Objects below an object with Page Break Before set to Yes may not move to the next page.Page Break Before
Description The Page Break Before property indicates that you want the object to be formatted on the page after the page on which it is initially triggered to print. Applies to layout objects Required/Optional optional Default No
Page Break Before restrictions
n For repeating frames. Page Break Before sets a logical page break before the repeating frame as a whole.

Suppose further. For ease of reading. Setting Page Protect to Yes means that if the contents of the object cannot fit on the current logical page. Note: Using Page Protect may cause objects below the page protected object(s) to appear above the page protected object(s). Report Builder will try to print M_1 and all its objects on the next logical page. that M_1 and all its fields cannot fit on the second logical page on which Report Builder tries to print it. Applies to layout objects Required/Optional optional Default No
Page Protect example (small object)
Suppose that you have created a frame named M_1 with a number of fields that display various columns and summaries. you specify Page Protect for the master repeating frame (the outermost repeating frame). though. See the online help for details and illustrations.Page Protect
Description The Page Protect property indicates whether to try to keep the entire object and its contents on the same logical page. To do this. they will be triggered to print on the next page instead. If M_1 and all its fields cannot fit on the first logical page that Report Builder attempts to print them. you want to keep all of the fields in M_1 on the same logical page so that readers can see the columns and their summaries together. you would like to have all of the details and the master appearing on the same page.
Page Protect example (group report)
Suppose that you have a group report. If the details and the master cannot fit on the first page on which they are triggered to print. Report Builder will try to print M_1 and all its objects on the next logical page. Specify Page Protect for M_1. If at all possible. For ease of reading. you want to keep all of the fields in M_1 on the same logical page so that readers can see the columns and their summaries together. the object and all of its contents will be moved to the next logical page.
Report Builder Reference
231
. Specify Page Protect for M_1. Report Builder will print as much of M_1 as it can on the logical page and print the rest of it on the following logical page.
Page Protect example (large object)
Suppose that you have created a frame named M_1 with a number of fields that display various columns and summaries. If M_1 and all its fields cannot fit on the first logical page that Report Builder attempts to print them.

setting Page Protect will not effect them. See the online help for details and illustrations.Page Protect restrictions
n Page Protect applies only to the first logical page on which the object is triggered to be formatted. an object alongside the page protected object may or may not be moved as well. but not to instance 3. if page protection had been applied to instance 3. Otherwise. The only exception is that page protection is not applied to the first instance on a page other than the first page of the repeating frame. it would have started on page 3 instead of page 2. the object will print on that logical page. n If Page Protect causes an object to be moved to the next logical page when formatting. For example. in this case. Page Protect is ignored on subsequent pages. Page Protect refers to each instance of the repeating frame.. the object will be moved along with the page protected object to the next logical page. When repeating frames are related via matrix object. page protection is applied to instances 1. Notice that. Page Protect will not be applied. n Page Protect is not supported for repeating frames that are part of a matrix. Each instance of the repeating frame and its enclosed objects will be kept together by Page Protect. This would have left page 2 almost completely blank.
232
Report Builder Reference
.g. Instance 3 is the first instance to format on the second page of the repeating frame. and 4. n For repeating frames. a page heading). n If moving the object and its contents to the next logical page would leave the current logical page blank or only containing repeated objects (e. If the object alongside the page protected object is not anchored (implicitly or explicitly) to the page protected object. This prevents unnecessary blank pages in your report. 2. in the diagram below. and that object can fit in the space where the page protected object could not fit.

Values Anchoring Object Is the parent object to which the current object is implicitly or explicitly anchored.Base Printing On
Description The Base Printing On property is the object on which to base the Print Object On property of the current object. For example. Enclosing Object Is the object that encloses the current object. if you specify a Print Object On of All Pages and a Base Printing On of Anchoring Object. Applies to layout objects Required/Optional required Default Anchoring Object
Report Builder Reference
233
. the current object will be triggered to print on every logical page on which its anchoring object (parent object) appears.

g. All but Last Means the object and all of its contents will be printed on all Page logical pages of the Base Printing On object except the last logical page. the last page is considered to be the last logical page on which some part of the object is printed. Last Page Means that the object and all of its contents will only be printed on the last logical page of the Base Printing On
234
Report Builder Reference
. Values All Pages Means the object and all of its contents will be printed on all logical pages of the Base Printing On object. *Default Means that Report Builder will use object positioning to set the Print Object On to either *First Page or *Last Page for you. The object will be repeated on any overflow pages of the Base Printing On object and will be truncated at the logical page boundary. All but First Means the object and all of its contents will be printed on all Page logical pages of the Base Printing On object except the first logical page. Other settings (e.Print Object On
Description The Print Object On property is the frequency with which you want the object to appear in the report. Page Break Before) or the amount of space available on the page may cause Report Builder to print an object on a page other than the one on which it was initially triggered to print. The object will be repeated on any overflow pages of the Base Printing On object except the last one and will be truncated at the logical page boundary. if necessary. The object will be formatted and will overflow to subsequent pages. (The asterisk indicates that Report Builder specified the setting for you. The Print Object On options indicate the logical page(s) on which the object should be triggered to print with regard to the Base Printing On object.) First Page Means that the object and all of its contents will only be printed on the first logical page of the Base Printing On object. For example. if necessary. Likewise.. if you specify a Print Object On of First Page and a Base Printing On of Enclosing Object. if necessary. The object will be formatted only on overflow pages of the Base Printing On object and will be truncated at the logical page boundary. In applying these options. the object will be triggered to print on the first logical page on which its enclosing object appears. Report Builder considers the first page of an object to be the first logical page on which some part of the object is printed. Note: Just because the object is triggered to print on a logical page does not mean it will print on that logical page. if necessary.

Object A. Applies to layout objects Required/Optional required Default varies according to object
Print Object On example (all)
Suppose that you have created a summary column named Col_Sum that sums the values of a column in a group named Group_1. you would think that these two objects could never appear on the same page.
Print Object On restrictions
Caution: If its contents cannot fit within the logical page on which it starts to print. if one object has a Print Object On of First Page
Report Builder Reference
235
. All But First Page. however. a Print Object On of First Page and a Print Object On of All But First Page are not necessarily mutually exclusive. which contains the values from Group_1. however.
n If its contents cannot fit within the logical page on which it starts to print. Looking at the Print Object On setting of objects A and B (All But First Page and First Page). In this scenario. truncated contents on every logical page it is triggered to print. The Print Object On of All But First Page in this case means to trigger the object to print on every logical page of each instance of the repeating frame. In this case. they can only appear on the same page. As a result. boilerplate objects A and B’s Base Printing On setting refer to each instance of repeating frame C. it only overflows to a second page when boilerplate object B overflows. The object will be formatted after the Base Printing On object and will overflow to subsequent pages. For example. the contents of the object will be truncated and the object will print with the same. Object D appears on all logical pages on which repeating frame C appears. As a result of overflow. Since repeating frame C only contains two objects (boilerplate objects A and B). except for the very first page on which an instance prints. even though it is triggered to print only on the first or last page.
Print Object On example (overflow)
See the online help for details and illustrations. If you specify a Print Object On of All Pages and a Base Printing On of Enclosing Object for F_1. it may overflow beyond the first or last page. Since they are inside the repeating frame. only prints when an instance of repeating frame C overflows. it prints in every instance of R_1 on every logical page.object. boilerplate object D’s Base Printing On setting refers to the repeating frame as a whole. an object with a Print Object On of First Page or Last Page can overflow onto subsequent pages. Because it is outside of repeating frame C. an object with a Print Object On of All Pages. if necessary. Col_Sum is the source of a field (F_1) that is enclosed in a repeating frame (R_1). or All But Last Page cannot overflow onto subsequent pages.

then it refers to each instance of the repeating frame to which the object is anchored. As a result not all Print Object On settings make sense for margin objects. See the online help for details and illustrations. the Base Printing On would refer to the instances of the repeating frame. it is as if you are always on the first page of the object. suppose the Base Printing On of an object is a repeating frame and the object is outside of the repeating frame. does not mean the first instance of the repeating frame. the two objects could appear on the same page. n Whether the Base Printing On setting refers to a repeating frame as a whole or the instances of a repeating frame. n Objects in the margin region are restarted on every physical page. An object that is anchored to another object within its frame or repeating frame cannot have a Print Object On of Last Page or All But Last Page with a Base Printing On of Enclosing Object. In this case. then it refers to the repeating frame as a whole.
n An object that is implicitly or explicitly anchored to its enclosing frame or repeating frame cannot have a Print Object On of Last Page or All But Last Page."
236
Report Builder Reference
. First Page is the same as All Pages. if the object with First Page overflows onto the second page. It means the first logical page on which each instance of the repeating frame is triggered to print. a Print Object On of First Page means the first logical page on which the repeating frame is triggered to print. you might think that the two objects could never appear on the same page. however. For example. n If the Base Printing On setting of an object is a repeating frame that encloses the object. Because objects are restarted on every page. However. For example.and another has All But First Page and they both have the same Base Printing On setting. A Print Object On of First Page. the Print Object On setting always refers to logical pages. Last Page and All But Last Page are invalid because "last" is never reached. All But First Page causes the object to never appear because the object never goes beyond "first. n If the Base Printing On setting of an object is a repeating frame and the object is outside of the repeating frame.

Values Enter a valid printer code reference not to exceed 256 bytes in length. The Printer Code Before property references the printer escape sequence to be executed before each line of the object. Entries may be of the form &number. where number is a number assigned to a packaged Report Builder printer code or a printer code you’ve created.g.
Report Builder Reference
237
. special font sizes or highlighting) for the object. use the SRW..SET BEFORE PRINTING CODE procedure. you should be able to accomplish any special formatting by writing PL/SQL for the layout objects.Printer Code Before
Description Printer Codes are references to printer escape sequences that define special printing instructions (e. The printer escape sequences are inserted after the object is triggered to print but before it has actually printed. PL/SQL To define this attribute using PL/SQL. Applies to layout objects Usage Notes
n In most cases.

PL/SQL To define this attribute using PL/SQL. where number is a number assigned to a packaged Report Builder printer code or a printer code you’ve created.
238
Report Builder Reference
. On the property sheet for the R_1 repeating frame. Code &123 causes the printer to print a special font and code &456 causes the printer to print the normal font.
Printer Code Special Font example
Suppose that in your printer definition file you created two printer codes named &123 and &456. The Printer Code After property references the printer escape sequence to be executed after each line of the object.. See the online help for details and illustrations. You could either use the printer code for each individual field or use it for the entire repeating frame. Assume that you want all fields in a repeating frame (R_1) to be printed using the special font. you enter &123 for Printer Code Before. Applies to layout objects Usage Notes
n In most cases. They are not used when running it in bitmap.
Printer Code restrictions
n Printer codes are only used when running your report in character-mode. The printer escape sequences are inserted after the object is triggered to print but before it has actually printed.SET AFTER PRINTING CODE procedure. the printer code will be executed before and after each line of R_1 is printed.Printer Code After
Description Printer codes are references to printer escape sequences that define special printing instructions (e. When R_1 is printed. you should be able to accomplish any special formatting by writing PL/SQL for the layout objects. The latter case is easier to create and maintain. Entries may be of the form &number. special font sizes or highlighting) for the object. Values Enter a valid printer code reference not to exceed 256 bytes in length. and &456 for Printer Code After.g. use the SRW.

See the online help for details and illustrations. which means the height shown in the Report Editor has no effect on the object’s height at runtime. but it cannot increase to a height greater than that shown in the Report Editor. (You can think of this option as meaning "only contract. elasticity defines whether the size of the frame or repeating frame should vary with the objects inside of it. if the formatted objects or data within it are tall enough. elasticity defines whether the field or boilerplate should vary with the size of the text. but it cannot decrease to a height less than that shown in the Report Editor. Applies to layout objects Required/Optional required Default varies according to the object Usage Notes n If you create a chart object in your report with a Vertical and Horizontal Elasticity of Fixed. if the formatted objects or data within it are short enough. The elasticity options for images. Fixed size text will wrap within the defined size of the object and may be truncated if there is not enough room. Report Builder scales the Graphics Builder display to fit within the
Report Builder Reference
239
. and chart objects determine the scaling factor. and chart objects. Variable Means the object may expand or contract vertically to accommodate the objects or data within it (with no extra space). do not contract. look at the examples. Truncation of data may occur. Truncation of data may occur.") Expand Means the vertical size of the object increases.") Fixed Means the height of the object is the same on each logical page. drawings. Values Contract Means the vertical size of the object decreases. do not expand. look at the examples. drawings. regardless of the size of the objects or data within it. Report Builder uses proportional scaling.Vertical Elasticity
Description The Vertical Elasticity property is how the vertical size of the object may change at runtime to accommodate the objects or data within it:
n For frames and repeating frames. (You can think of this option as meaning "only expand. The height of the object is defined to be its height in the . Number or date data will appear as asterisks if the data cannot fit within the defined size. n For objects containing text. n For images.

Because the Vertical Elasticity is Variable. all of M_2 would have printed on the second logical page. if Vertical Elasticity is Fixed. See the online help for details and illustrations. then use SUBSTR in your SELECT statement to retrieve only those characters from the database. See the rules below for details about images.
240
Report Builder Reference
. drawings. and chart objects cannot overflow. See the online help for details and illustrations. called M_1. Note that all of M_2 cannot fit on the first logical page. Report Builder will only format it on a logical page if the page has enough space to contain the entire object. Had the Vertical Elasticity been Fixed. if you want only the first four characters of a column. you should use the SQL SUBSTR function in your query. Additional Information: If you want your data truncated. M_2 requires eight inches vertically to format.
n When formatting an object. its Vertical and Horizontal Elasticity determine whether the contents overflow onto the next page or are truncated.dimensions you defined for the object.
Vertical Elasticity example (variable)
Suppose that you have a frame named M_2 with the following characteristics: Characteristic Value width 5 inches Horizontal Fixed Elasticity Vertical Variable Elasticity Assume further that the Page Height for the report is twelve inches. Another frame. the first five inches of M_2 are printed on the first logical page and the last two inches are printed on the second logical page. For example. drawings. Because of the size of the objects within it. and Graphics Builder displays. The following diagram shows how the frame might be formatted. Images.
Vertical Elasticity example (expand)
Suppose that you have a field with the following characteristics: Characteristic Value width 1 inch Horizontal Fixed Elasticity height 2 inches Vertical Expand Elasticity See the online help for details and illustrations.
Vertical Elasticity restrictions
Caution: If the contents of an object exceed its defined height. precedes M_2 on the logical page and takes up six inches.

you either need to resize the object or change its elasticity to Expand or Variable. Report Builder will only format the object on a logical page if the page has enough space to contain the defined height of the object (i. n If an object containing an image. Report Builder will always attempt to have the contents fill up the Fixed dimension. then asterisks will appear in the field instead of the value.. In some cases. then the image will only fill the object in one direction. In the other direction. then the contents will appear the same size as they do in their source (e. If formatting is not complete. Report Builder will format as much of the object as possible on the first logical page and. or a Graphics Builder display is Fixed in only one direction. n If the elasticity of the object is Contract in one direction and Fixed in the other. Vertical or Horizontal Elasticity is Variable) and the object cannot fit in its enclosing object (e.e. drawing. if an object is fixed both horizontally and vertically and the image is too large for the object..n If Vertical Elasticity is Expand. then proportional scaling is performed on the contents.g. the contents may be clipped. n If a number cannot fit in its field.e. the image will be shorter than the object. Report Builder will change it to be fixed
Report Builder Reference
241
. n If a value to be displayed in the report output relies on the formatting of the report.. make it variable horizontally.) If the elasticity is not fixed.e.g. n If Vertical Elasticity is Variable or Contract. n If the elasticity of the object is variable (i... this may lead to empty space or "gaps" between the contents and the border of the object.g. its minimum size). both Vertical and Horizontal Elasticity are Variable). then the field or boilerplate object that displays the value must have a Vertical and Horizontal Elasticity of Fixed. complete the object on the following logical page(s).. vertically.e. make it Variable both horizontally and vertically) or you can manually resize the object. To avoid these gaps. the object overflows to the next page. n The following elasticity rules apply to objects (e. a frame or the logical page). the source file). the report will infinitely loop (because the object can never format). (This is sometimes referred to as page-dependent referencing. if necessary. you can either change the elasticity (e.g. fields or boilerplate) that contain an image. n If the elasticity of the layout object is fixed (i. drawing. To avoid clipping of the contents.. you can either change the elasticity (e. For example.g. both Vertical and Horizontal Elasticity are Fixed). or both) or you can manually resize the object... or Graphics Builder display: n If the elasticity of the layout object is variable (i. To get the value to appear.

in the Page Numbering dialog box. Note: If a field containing a page-dependent reference has Visible set to No. the field’s elasticity must be fixed. then any layout object that displays its value must have fixed elasticity. though. so that Report Builder knows how much space to reserve for it before its source value is determined. But Report Builder must format the field before the end of the report and cannot wait until the report is completely formatted to determine how big to make the field. must be fixed in elasticity. &Total Logical Pages.at runtime.
242
Report Builder Reference
. n If a formula or summary column relies on a summary column that has a Reset At or Compute At of Page. The total number of logical pages cannot be determined until the entire report has been formatted. or Contract. then any object that displays the field (either the field itself or a boilerplate object) must have fixed elasticity. Following are cases of page-dependent referencing. &Total Panels. then the field may have Horizontal Elasticity of Variable. then the field or boilerplate object that displays its value must have fixed elasticity. n If a field has a page number as its Source and. n If the Source of a field is &Logical Page Number. Consequently. &Panel Number. Any boilerplate object that references the field. where a field or boilerplate object’s elasticity must be fixed because its source value depends on the formatting of the report:
n If a summary column has a Reset At or Compute At of Page. Expand. A typical case of page-dependent referencing is a field that has a Source of &Total Logical Pages. Reset At is a repeating frame. &Physical Page Number. then the field or boilerplate object that displays its value must have fixed elasticity. or &Total Physical Pages.

the property will be transferred to all the child (interior) objects that do not have a Hyperlink property specified. http://www.newmach.com/cgibin/webmenu?choice1) n destination within a remote document (e. #my_dest_name) n destination within a local document (e.SET HYPERLINK procedure. If a Hyperlink property is specified for an object in a frame.reposit.Hyperlink
Description The Hyperlink property is a URL link specification that displays a document or destination within a document when the object is clicked in the Web browser or PDF viewer.somemch. If the Application Command Line property is set for an object.g.. it will be applied to the object. If the property cannot be transferred to the child objects..
Report Builder Reference
243
. http://www.com/newdoc. Otherwise.com/newdoc..g. Values Any valid link to a:
n destination within the current document (e. A report output in PDF format can include both hyperlinks and application command line links. where filename is the name of frame to replace..
n
n
PL/SQL To define this attribute using PL/SQL.newmach.pdf#some_dest_name) Applies to layout objects Default blank Usage Notes n
If a Hyperlink property is specified for a frame.pdf. http://www. the frame’s Hyperlink value is lost. include the following HTML in the Additional Hyperlink Attributes property setting: target=filename.newmach.pdf) n document on a remote machine (e. To replace only the frame. http://www. file:/private/mynewdoc.pdf#a_dest_name) n document on the local machine (e. file:/private/somedoc.example.g.html.g. use the SRW.com/newdoc.pdf or file:///C|/temp/mynewdoc.com/filetoget.. clicking the object will by default replace the frame with an entire window displaying the destination of the hyperlink. the Hyperlink property is applied.g. ftp://www.

Hyperlink restrictions
n
To follow Web links from a PDF viewer to a remote server or HTML document.
244
Report Builder Reference
. the PDF viewer must be configured to work with a Web browser (e. configured as a helper application or installed as a plug-in to your Web browser).g..

SET LINKTAG procedure. which can be used as the destination of a Web link. or underscore characters.
PL/SQL To define this attribute using PL/SQL.
Report Builder Reference
245
. numbers. Values A valid. Applies to layout objects Required/Optional Required. Other special characters will automatically be converted to underscore characters. Default blank Usage Notes
n
If a Hyperlink Destination property is specified for a frame.Hyperlink Destination
Description The Hyperlink Destination property is a unique identifier for an object. if you want to set a Hyperlink property for an object that specifies this object as its destination. unique name that only makes use of the 26 upper or lower case US ASCII letters. use the SRW. the property is transferred to the visible object nearest to the upper left corner of the frame.

1#Expenses for the Administration Department 2.3.1 will cause dummy 2 and 2.Bookmark
Description The Bookmark property is a Web link that will appear in a bookmark frame of the master HTML document or in the bookmark area of the PDF viewer. If the gap is between a higher level number and a lower level number.g. 1.3. 1.2. all entries appear but the order is defined by when the objects are rendered by the report.
246
Report Builder Reference
. use the SRW.3. intermediate levels will be generated as required (e.
Bookmark example (with indentation/ordering)
1#Expense Summary Section 2#Expense Detail Section 2.3. Applies to layout objects Default blank Usage Notes
n
If a Bookmark property is specified for a frame.3.1#Expenses for the Eastern Sales Region 2. If the gap is between peer level numbers.2#Expenses for the Northern Sales Region 2.SET_BOOKMARK procedure. whose titles will be the same as the subsequent real entry)..1.3#Expenses for the Sales Department 2.3.g.0 followed by 2.3#Expenses for the Southern Sales Region 2. where x is an outline number.3. Values A text string with no indentation/ordering information. The pound sign (#) and outline number do not appear in the bookmark window but are used to determine order and indentation. The bookmark will appear in the bookmark list according to when the object is rendered by the report. will appear next to each other and at the same indentation level).3.1 entries to be defined. there will be no visible effect (e..4#Expenses for the Western Sales Region
Bookmark restrictions
n If the same outline number is used multiple times.2#Expenses for the Engineering Department 2.
PL/SQL To define this attribute using PL/SQL. the property is transferred to the visible object nearest to the upper left corner of the frame. one of two things will happen. A text string with explicit ordering/indentation of the form x#book_mark_name . n If there are gaps in the numbers. given there is no 1.1 and 1. Clicking on the bookmark displays the associated object at the top of the window.

the Hyperlink property is applied..
PL/SQL To define this attribute using PL/SQL. c:\orawin\bin\rwrun60 userid=scott/tiger report=example. If the Application Command Line property is set for an object.g.
Application Command Line (PDF) restrictions
n
The Application Command Line property is only available for PDF output.rdf or /usr/local/bin/phone smith) Applies to layout objects Default blank
n
A report output in PDF format can include both hyperlinks and application command line links.Application Command Line (PDF)
Description The Application Command Line (PDF) property is a command line that will be executed on the local machine when the object (in a PDF document) is clicked in the PDF viewer. use the SRW. it will be applied to the object. Otherwise.SET_PDF ACTION procedure. Values Any valid command line on the local machine (e.
Report Builder Reference
247
.

Report Builder Reference
249
. Default blank Usage Notes
n n
When you output your report in HTML or HTMLCSS format. Applies to image objects in HTML reports.Display Name
Description The Display Name property is text that displays in a popup as the cursor moves over an image object in reports output in HTML or HTMLCSS format. Values A text string not to exceed 256 characters. the Display Name property value is inserted into the IMG tag using the HTML ALT tag. use the SRW. If there is a hyperlink defined against the image object.SET DISPLAY NAME procedure. you can also use the Additional Hyperlink Attributes property to generate a status line of information.
PL/SQL To define this attribute using PL/SQL.

Values Yes Means Live Previewer will stop searching for aligned objects at the end of the frame. Applies to frames Required/Optional required Default varies according to the object
250
Report Builder Reference
.End of Layout Section
#
Description The End of Layout Section property determines where the Live Previewer will stop searching for aligned objects. This property is used primarily in character mode and is used to restrict the scope of search for matching objects. No Means Live Previewer will search for all objects aligned in the same direction.

clicking the object will by default replace the frame with an entire window displaying the destination of the hyperlink. Applies to layout objects with a link defined by the Hyperlink property.SET HYPERLINK ATTR procedure. To replace only the frame. where filename is the name of frame to replace. If no link is defined. use the SRW. Values Any valid HTML tags for the link defined by the Hyperlink property. Default blank Usage Notes
n
If a Hyperlink property is specified for an object in a frame.
Report Builder Reference
251
.
PL/SQL To define this attribute using PL/SQL.Additional Hyperlink Attributes
Description The Additional Hyperlink Attributes property specifies additional HTML attributes to be applied to the link defined by the Hyperlink property. include the following HTML in the Additional Hyperlink Attributes property setting: target=filename. this property has no effect.

Database Column properties
Break Order Column Type Comment Database Column Name Datatype File Format Name Read from File Value If Null Width
Database Column restrictions
n Only Report Builder can create database columns (it creates one for each item in the SELECT lists of your queries). you must add to the SELECT list of your query and Report Builder will then create the database column for you.
252
Report Builder Reference
. n Database columns can only be deleted by removing the associated item from the SELECT list. To create a database column.

There is no limit to the number of lines that can be created. hyphens..Field properties
Additional Hyperlink Attributes Application Command Line (PDF) Base Printing On Bookmark Comments Contains HTML Tags Format Mask Format Trigger Horizontal Elasticity Hyperlink Hyperlink Destination Keep With Anchoring Object Minimum Widow Lines Name Page Break After Page Break Before Page Numbering Page Protect Print Object On Printer Code After Printer Code Before Source Source Datatype Vertical Elasticity Visible
Field restrictions
n The maximum size of text in a field is 64K of text per paragraph and 64K paragraphs. on spaces. If a field’s source is a summary owned by a cross-product group. n In the Layout Model view.e. This limit may vary according to your operating system. n The contents of fields are wrapped on word boundaries. and tabs. then the field must be placed inside of the set of repeating frames whose sources are
Report Builder Reference
253
. New line characters in the field’s contents force new lines. Other punctuation marks are considered to be the last character of the word they follow. a field must be placed inside of a repeating frame whose source group is the group (or a descendant of the group) that contains the field’s source column. i.

you either need to resize the object or change its elasticity to Expand or Variable. n If a number cannot fit in its field. then asterisks will appear in the field instead of the value.
254
Report Builder Reference
.
n A field must be in front of the repeating frame that contains it.the groups in the summary column’sProduct Order . To get the value to appear.

Long Raw.Source Datatype
Description The Source Datatype property is a read-only field that displays the Datatype of the field’s Source. Applies to fields Usage Notes
n
A field of Datatype Long.
Report Builder Reference
255
. or Raw is treated as text unless you specify otherwise in the Format field of the Column Property Palette.

for a field of Datatype Number..g. Blank means Report Builder will format the values based on the Datatype of the field’s Source. the format mask is the default for your language (e.Format Mask
Description The Format Mask property defines how you want to display Date and Number values in the field. if the Datatype of the field’s Source isNumber. See the online help for details and illustrations.
n
Custom format masks are only valid during the current Report Builder session. use Edit Masks in the Tools Options dialog box (Tools-->Tools Options).. use the SRW.1. To include masks in the list that will be saved between sessions. Character values have no format mask.
256
Report Builder Reference
.
PL/SQL To define this attribute using PL/SQL. If you quit Report Builder and then invoke it again. the default is ’DDMON-RR’).g. You can enter custom masks for numbers and dates or you can select from the list of values. The values displayed initially in the list are determined by the Datatype of the field (e. in the United States.SET FORMAT MASK procedure. Applies to fields Required/Optional optional Default blank Usage Notes
n
If you leave this field blank and the Datatype of the field’s Source is Date. This default behavior is the same as in SQL*ReportWriter Version 1. the values are formatted according to the width of the Source (see table below). Values Any valid number or date format mask not to exceed 1K. If you enter a mask not in the list for Format Mask and accept the Field Property Palette. only number masks are shown in the list). the list of values for the Format Mask field does not contain the format masks you created in the previous Report Builder session (unless you open the report(s) that used these masks). the new format mask will appear in the list of values.

2.M. spelled out. ’S’ prefixes "BC" with (-) SYYYY or YYYY Year. seconds in day FM Toggles fill mode which replaces multiple spaces before or between dates. and time: Format Mask Explanation SCC or CC Century.C. abbreviated. ’S’ prefixes "BC" date with (-) RRRR or SRRRR Year.4712 BC DDD. DD. MON) AM. or 3 digit(s) of year Y or YY or YYY Last 1. numbers. AD. or 3 digit(s) of year Y.D. or A. 3-letter abbreviation (e. 2. ’S’ prefixes "BC" date with a (-) I or IY or IYY Last 1. the number of days since January 1. IW Week in year W Week in Julian days J Julian day.g. Century indicator A.g. or week DAY Day of week fully spelled out (e.. ’S’ prefixes "BC" date with a (-) RR Last 2 digit(s) of year BC.. or 3-letter abbreviation WW. or D Day in year. HH or HH12 Hour of day (1-12) HH24 Hour of day (0-23) MI Minute SS. MONDAY) DY Name of day. Q Quarter of year (Jan-Mar=Quarter 1) MM Month in digits (Jan = 01) MONTH or MON Name of month. PM. or B.Date and Time Format Mask syntax
The following tables describe the format masks for dates and the suffixes you can add to them..YYY Year with comma SYEAR or YEAR Year.. Meridian indicator P. or words with a single space The following suffixes may be added to the format masks: Suffix Explanation TH Suffixed number ("DDth" for "4th")
Report Builder Reference
257
. month.M. SSSSS Second in minute.

SP SPTH or THSP
Spelled out number ("DDSP" for "FOUR") Spelled and suffixed number ("DDSPTH" for "FOURTH")
258
Report Builder Reference
.

in which case an asterisk (*) is printed. Y Causes no sign symbol to be printed for negative or positive values. unless it is a leading zero to the left of the decimal point or a trailing zero to the right of the decimal point. () Prints parentheses around negative values and spaces around positive values. * Prints one digit. *. This token must lead the other tokens. + Prints a leading plus (+) for positive values and a leading minus (-) for negative values. 9 Prints one digit. S Prints a minus (-) for negative values and a plus (+) for positive values (wherever the S appears in the mask). Trailing zeros to the right of the decimal point are printed. 9. This token must trail the other tokens. and S tokens that appear to the right of the V. The parentheses must surround the other tokens. EEEE Causes the number to be printed in scientific notation. V Causes the number to be multiplied by 10N. This token must lead the mask. This token must trail the other tokens. in which case a space is printed. This token must lead or trail the other tokens. where N is the number of 0. This token must trail the other tokens. DB Prints a "DB" after positive values. Prints a leading minus (-) for negative values and nothing for positive values. Trailing zeros to the right of the decimal point are printed. All digit tokens refer to digits of the mantissa. This token must trail the other tokens. N Prints one digit.Number Format Mask syntax
The following table describes the tokens you can use in creating a number format mask: Format Token Explanation 0 Prints one digit. PR Prints angle brackets (<>) around negative values and spaces around positive values. unless it is a leading zero to the left of the decimal point. unless it is a leading zero to the left of the decimal point. There must be
Report Builder Reference
259
. CR Prints a "CR" after negative values. MI Prints a minus (-) after negative values and a space after positive values.

Prints %. Prints the string between the double quotes.e. Angle brackets indicate that the number should always occupy the same amount of space. 1985 Day Month DD fmHH:MI Monday March 4 11:35 AM AM Dy Mon ddth fmHH24:MI:SS Mon Mar 4th 23:35:22 Day "the" ddthsp "of" Month Monday the fourth of March
260
Report Builder Reference
. E-99). and a minus (-). type double-quotes back to back (""). Prints a blank space. Prints the local group/thousands separator.g. Prints a blank space. (comma) G $ L C % "" v K <>
RN.. values are padded with blanks to the left or right of the decimal point. Prints the ISO currency symbol. RRRR Mar.
Format Masks examples
The following tables illustrate some sample format masks: Sample Date Format Date Displayed MM/DD/RR 03/04/85 DD MON RRRR 04 MAR 1985 Mon. that part of the number that you want aligned with the decimal point in the format mask)."string"
. The token EEEE prints as E followed by a plus (+).) to separate the integral and fractional parts of a number. Prints values in uppercase or lowercase Roman numerals. if the ordinate is positive or zero. Prints the local currency symbol. 4. respectively. Delineates the beginning and ending of the decimal-aligned region (i. To have double-quotes inside the string. (period) D . Prints $. and two digits representing the ordinate (e. If necessary.. rn
exactly one digit to the left of the decimal point (displayed or implicit). Prints the local decimal character to separate the integral and fractional parts of a number. DD.) as the group/thousands separator. Prints a period (. Prints a comma (. You cannot enter any other tokens with this token. (Do not include quotes in mask.) Prints a blank space for all zero values. regard-less of other tokens. if the ordinate is negative.

the value is 1234. the value is too long to be displayed in a field of width 6. Format masks that print spaces for zeros (e.Similarly. 9) increase the number of bytes per page taken up by your output..1.e. This behavior is different from the default behavior in SQL*ReportWriter Version 1. Specifying the Y format mask token causes the Version 1.. and format masks for dates are displayed when the Source is a date. As a result. your output will be ******. if the number format mask causes the value to be larger than the field width.1 default behavior.
n
n
Format restrictions
n Sound and Video sources can only be accessed from user-created buttons. and the format mask is -99999999. positive values are preceded by a space and negative values are preceded by a minus (-).
n
If you do not specify a sign token in the format mask. if a fixed field’s width is 6. asterisks will appear in place of the value. format masks for numbers are displayed when the Source is a number. For example. After you create a format mask it will display in the list of values only if it is an appropriate format mask for the Datatype of the Source --i.
262
Report Builder Reference
. This occurs because the format token 9 prints a blank for leading zeros to the left of the decimal.g.

Visible
Description The Visible property indicates whether or not the field should be formatted. Report Builder will assume that all of the text between the ampersand and the next space is part of the field name.g. CA 11104 415-363-1234
Hidden Field restrictions
The following properties and attributes of a hidden field are applied to references to the hidden field:
Report Builder Reference
263
. If you want to place the field reference next to other text with no s3paces in between. address.. that you can put references right next to each other with no spaces in between and without angle brackets (e. This is used for fields that you only want to reference in boilerplate text. If set to No. the letter would look something like this: Dear J. Our records show that your address and phone are the following: &ADDRESS &PHONE In the output. Hidden fields are most often used for form letter reports. ADDRESS for the address. however.
Hidden Field Reference example
Suppose that you are building a form letter report and you want to insert the name.g. You create a field called NAME1 for the name of the addressee. &<fieldname>Kg). enclose the field name in angle brackets (e. the field is hidden (not formatted). Note. you insert references as follows: Dear &NAME1. Smith.. where fields are referenced in boilerplate text. To reference a hidden field. These fields are only to appear within boilerplate text. and PHONE for the phone number. so you select No. Applies to fields Required/Optional optional Default Yes Usage Notes
n
A reference to a hidden field can appear anywhere in boilerplate text. Our records show that your address and phone are the following: 234 Summer Lane San Francisco. Otherwise. type &fieldname within the boilerplate text object. Within the boilerplate text where you want these values to appear. and phone number of the addressee in the letter. &field1&field2&field3).

Report Builder Reference
265
. &Total Number of Physical Pages. n Type &Report under Reset At because you want to number all the pages in the Main Section consecutively. n Type 1 in the Increment By setting.Page Numbering
Description The Page Numbering property determines how page numbers are calculated for fields that have a Source of &Physical Page Number. you want the page number to be of the form "Page n of m pages":
1
Create a field named F_PAGE and set the Source property to &Physical Page Number. or &Total Number of Logical Pages. Furthermore.
3
Position F_PAGE in the Layout Model view. n Type 1 in the Start At setting.
Page Numbering example (pages in body)
Suppose that you want to number the physical pages of the Main Section of your report:
1
Create a field named F_PAGE and set the Source property to &Physical Page Number. In the Field Property Palette.
Page Numbering example ("Page n of m pages")
Suppose that you want to have the page number at the top of each page of your report. Note: The settings for each page are based on the logical or physical page as specified by the field’s Source. set the Page Numbering property by filling out the Page Numbering dialog box as follows:
2
n Check Main Section and uncheck Header Section and Trailer Section because you only want to number the Main Section pages. n Type 1 in the Increment By setting. n Type 1 in the Start At setting. &Logical Page Number. See the online help for details and illustrations. In the Field Property Palette for F_PAGE. set the Page Numbering property by filling out the Page Numbering dialog box as follows:
2
n Check Main Section and uncheck Header Section and Trailer Section because you only want to number the Main Section pages.

In the Field Property Palette for F_PAGE. Insert boilerplate between F_PAGE and F_TOTPGE that contains the text "of". set the Page Numbering property by filling out the Page Numbering dialog box as follows:
2
n Check Main Section and uncheck Header Section and Trailer Section because you only want to number the Main Section pages. set the Page Numbering property by filling out the Page Numbering dialog box as follows:
4
n Type &R_1 under Reset At because you want the page numbers to reset at each repeating frame instance..
3
Create a field called F_TOTPGE and set the Source property to &Total Number of Physical Pages. n Type &R_1 under Reset At because you want the page numbers to reset at each repeating frame instance. In the Field Property Palette for F_TOTPGE. n Type 1 in the Increment By setting.n Type &Report under Reset At because you don’t want the page numbers to reset to zero until the report is done. Insert boilerplate to the left of F_PAGE that contains the text "Page".
3
Create a field called F_TOTPGE and set the Source property to &Total Number of Physical Pages. position F_PAGE and F_TOTPGE beside each other. n Type 1 in the Start At setting.e. Do either of the following:
4
n Hide these fields (i.
5
Set the Print Condition of F_PAGE and F_TOTPGE such that they will print on all logical pages of R_1:
n set the Print Condition Type property to All
266
Report Builder Reference
.
Page Numbering example (repeating frame instances)
Suppose that you have a repeating frame (R_1) with instances that span several pages and you want to number the physical pages that each instance spans. set the Visible property to No) and reference them within boilerplate text:
Page &F_PAGE of &F_TOTPGE
n Alternatively. Assume also that you want the page number to be of the form "Page n of m pages":
1
Create a field named F_PAGE and set the Source property to &Physical Page Number.

This ensures that the field will only appear when the repeating frame appears. Insert boilerplate to the left of F_PAGE that contains the text "Page". To avoid this situation. Set Maximum Records Per Page to 1 for the repeating frame at which the the field’s value is reset. Create a Format Trigger for the field such that it will only be displayed on pages where its value makes sense (i.
Page Numbering restrictions
If the Reset At value is a repeating frame. and multiple instances appear on the same page.
Similarly.n set the Print Condition Object property to Enclosing Object
6
Do either of the following:
n Hide these fields (i. Because the value of the field is determined by the repeating frame. inside R_1.. To avoid this situation. set the Visible property to No) and create a boilerplate text object inside R_1 with the following text:
Page &F_PAGE of &F_TOTPGE
n Alternatively. Insert boilerplate between F_PAGE and F_TOTPGE that contains the text "of". pages on which one instance of the repeating frame appears). you can do any one of the following:
n n
Place the field inside the repeating frame at which its value is reset. if the field is not inside the repeating frame it resets at. using the Layout Model view. Report Builder cannot determine the value of the field and the results are again unpredictable.e.
Report Builder Reference
267
. you can do any one of the following:
n n
Place the field inside the repeating frame at which its value is reset. do not have the field appear on pages where the repeating frame does not appear.e. position F_PAGE and F_TOTPGE beside each other. the results will be unpredictable on pages where the repeating frame does not appear..

The figure shows a group tree. then any fields that use it as a source must be contained in repeating frames that use the column’s group as their source. &Total Panels Is the total number of panels within a logical page. &Logical Page Number).. &Physical Page Is the current page number based upon numbering Number the output by physical pages. it must be owned by the report.
Source restrictions
n
If a field is enclosed in a repeating frame. you can select Page Numbering to control how the page numbering is done. Values Any valid column or parameter name. after the Runtime Parameter Form is finished. &Logical Page Is the current page number based upon numbering Number the output by logical pages. See the online help for details and illustrations. &Total Logical Pages Is the total number of pages based upon numbering the output by logical pages. If the field has no enclosing repeating frame. Assume further that G_Dept is the Source for repeating frame R_Dept and G_Emp is the Source for repeating frame R_Emp. then the field Source could be 1. &Current Date Is the operating system date when the report runs. &Panel Number Is the current panel number within the logical page.g. the column used as its Source must be in the source group or an ancestor of the source group of the field’s enclosing repeating frame. Note: If Source is a page number value (e.Source
Description The Source property is the place where the field gets its values (usually a column or a parameter). See the online help for details and illustrations. In addition. or 6. If the source group of the repeating frame were 6.
n
If a column has a Reset At of Page.e. any boilerplate objects that reference the field must also be contained in
268
Report Builder Reference
. 3. i. the column must be a report-level column.. &Total Physical Pages Is the total number of pages based upon numbering the output by physical pages. Applies to fields Required/Optional required
Source example
Assume that you have a report with a data model like the one in the figure.

specify it as the source for a field. &Total Logical Pages. &Total Panels. or &Total Physical Pages.repeating frames that use the column’s group as their source.
n
If you specify a Source for a field and later delete that source from your report (i. and later delete that summary column). If the Source of a field is &Logical Page Number. &Physical Page Number. and *UNDEFINED* appears in the Source field. create a summary column.
n
n
Report Builder Reference
269
. &Panel Number. then any layout object that displays the field (either the field itself or a boilerplate object) must have fixed sizing..e. A field cannot have a Source of Sound or Video. your field no longer has access to data to display.

Number.Formula Column properties
Break Order Column Type Comment Datatype File Format Name PL/SQL Formula Product Order Read from File Set Break Order Value If Null Width
Formula Column restrictions
n You can set placeholder or formula columns to any of the following Datatypes: Character.
270
Report Builder Reference
. and Date.

272
Report Builder Reference
.Group properties
Child Dimension Comment Filter Type Name Number of Records PL/SQL Filter
Group restrictions
n Any group that is not the lowest group owned by a query must contain at least one column with Break Order specified. see "Matrix Restrictions". n For rules regarding cross-product groups.

Applies to dimension groups in a single-query. Note how only rows that contain values are printed.
Child Dimension example (set to Yes)
For the matrix below. the group containing deptno (G_DEPTNO) had Child Dimension set to No. G_Cross. matrix data models. Child Dimension would not be valid for G_1. you eliminate empty rows and/or columns in your matrix. matrix data model Required/Optional optional Default No Usage Notes
n When Child Dimension is set to No. Note how all rows are printed even if they contain no values. the group containing deptno (G_DEPTNO) had Child Dimension set to Yes. n In the example data model below. When you set Child Dimension to Yes. n Child Dimension is not valid for the topmost group in the data model. and G_YEAR. the lines between groups inside a cross product group are dotted.
Child Dimension restrictions
n Child Dimension is only valid for dimension groups in single-query. No Identifies the group as not a child dimension in a nested matrix report.Child Dimension
Description Child Dimension indicates whether a group is a child dimension group in a nested matrix data model.
Child Dimension example (set to No)
For the matrix below. Values Yes Identifies the group as a child dimension in a nested matrix report. It would be valid for G_DEPTNO and G_JOB.
Report Builder Reference
273
. the line between that group and its parent will become solid. By identifying which groups are child dimensions.

First Means that the first n records retrieved should be included in the group. Last Means that the last n records retrieved should be included in the group.
274
Report Builder Reference
. Values None Means that you are not using a filter for the group. Applies to groups Required/Optional optional Default None
Filter Type example
Suppose that you have a group named EMP that contains two columns (ENAME and SAL). which contains one column (DEPTNO). You specify a Filter Type of First and Number of Records of 3 for DEPT and a Filter Type of First and Number of Records of 5 for EMP. n Records excluded from the group by filter are not used in computations. where n is a number specified in the Number of Records property.
Filter Type restrictions
n If FilterType is First or Last. n A cross-product group cannot have a filter on it. The number cannot exceed 64K in size. where n is a number specified in the Number of Records property. PL/SQL Means that a PL/SQL function for determining which records to include in the group will be defined (or referenced). If you want to use data in calculations but not have it appear in the report output. This will return the first three department numbers retrieved by Report Builder with the first five names and salaries retrieved for each department. The parent group of EMP is DEPT. use a Format trigger to restrict what appears in the output.Filter Type
Description Filter Type specifies the type of filter Report Builder should use on the records being fetched for the group. you must specify a positive whole number in the associated field.

Enter any valid group name not to exceed 30 bytes. where n is a number that is unique among group names for the report.
Report Builder Reference
275
. Applies to groups Required/Optional required Default G_queryname. If the group is not associated with a query (i.e.g. Q_1). a cross product group).. the default group name is of the form: G_n. the default group name is also G_n. where queryname is the query’s name and a number that is unique among groups. If the query has a default name (e..Name
Description The Name property is the name Report Builder uses to identify the current group.

For example.Comment
Description The Comment property contains text that documents the group. you could describe the purpose of a break group so that someone else would be able to quickly understand what it does. Applies to groups Required/Optional optional Default blank
276
Report Builder Reference
. Enter any text not to exceed 64K.

then the first 20 records retrieved will be included in the group. Applies to groups Required/Optional Required.Number of Records
Description The Number of Records property is the number of records to include in the group when the Filter Type is set to First or Last. Values Enter a positive whole number. For example. when the Filter Type property is set to First or Last. Default 0
Report Builder Reference
277
. if the Filter Type is First. not to exceed 64K in size. and the Number of Records is 20.

Applies to groups Required/Optional Required. when the Filter Type property is set to PL/SQL.PL/SQL Filter
Description The PL/SQL Filter property is a button that displays the PL/SQL Editor in which you can enter a PL/SQL function for determining which records to include in the group.
278
Report Builder Reference
.

if the parent column is a character datatype (e. VARCHAR) then the child column also must be a character datatype (e. your output would look something like the figure below..g. AMOUNT FROM EMP. EMPNO.-----------ALLEN 7499 7499 3000 7499 810 7499 847 7499 24 7499 1500
Report Builder Reference
279
. AMOUNT FROM SALES ORDER BY REPID
To join these two queries. SALES WHERE EMPNO = REPID (+) AND JOB = ’SALESMAN’ ORDER BY REPID
Tip Using a Tablular style.Data Link properties
Child Column Child Query Condition Parent Column Parent Group SQL Clause
Data Model Link restrictions
n If you are creating a link with columns specified.. REPID.g. EMPNO FROM EMP WHERE JOB = ’SALESMAN’ Q_2: SELECT REPID. CHAR).-----. For example.-----. you create a link such that the link’s Property Palette settings are as follows: SQL Parent Column Condition Child Column Clause WHERE EMPNO = REPID This creates a link as if you wrote one query as follows:
SELECT DISTINCT ENAME. Ename Empno Repid Amount ----------. n
WHERE Clause Link example
Suppose that you are creating a master/detail report with the following two queries:
Q_1: SELECT DISTINCT ENAME. then you must have both a parent and a child column and the columns must have compatible datatypes.

which was selected in the parent query.
Report Builder Reference
281
. your parent and child queries might be written as follows:
Parent Query: SELECT DEPTNO FROM EMP Child Query: SELECT &PARM_1 COL_1. For example. Also. you need to create a link with no columns specified and then enter the SQL clause (e. To achieve this functionality. The Child Column must be a database column.Child Column
Description The Child Column property is the name of a column in the child query that relates to a column in the parent group (i. WHERE) for the link directly in the query. It also cannot depend upon a lexical reference (see "Child Column Restrictions"). Applies to links
Child Column restrictions
n A Report Builder link should not depend upon a lexical reference.e. neither the child column of a link or its table name should be determined by a lexical reference. this example assumes that you have created a link between the queries in the Data Model view with no columns specified. &PARM2 COL_2 FROM EMP WHERE &PARM_1 = :DEPTNO
Note how the WHERE clause makes a bind reference to DEPTNO. parent column). it cannot be a summary or formula. That is...g.

This field is read-only.Child Query
Description The Child Query property is the name of the query defined as the child when you created the link in the Data Model view. Applies to links
Child Query restrictions
n A Child Query can have only one Parent Group. Multiple parents for the same child are not allowed.
282
Report Builder Reference
.

Condition
Description The Condition property is a SQL operator that defines the relationship between Parent Column and Child Column. The pattern can contain % and _ as wildcard characters. Values = (equal to) < (less than) <= (less than or equal to) <> (not equal to) > (greater than) >= (greater than or equal to) Like Means that the condition is true when the value in one column matches the pattern in the other column. For details on SQL operators. The pattern can contain % and _ as wildcard characters. Applies to links Required/Optional required. Default = (equals sign)
Report Builder Reference
283
. Not Like Means that the condition is true when the value in one column does not match the pattern in the other column. see the ORACLE8 Server SQL Language Reference Manual . if a Parent Column is specified.

directly or indirectly. child column). If Parent Column is a summary or formula column. or formula column in the parent group. Parent Column can be a database. on a column owned by the child query.e. summary. it cannot depend.Parent Column
Description The Parent Column property is a column in the parent group that relates to a column in the child query (i. Applies to links
284
Report Builder Reference
.. This field is read-only.

This establishes a relationship between the two objects.
Report Builder Reference
285
. In other words. Applies to links Usage Notes
n You can create a link from a parent group to a child query without specifying any columns by which to link. your links cannot create a circular dependency (i. a situation where the child query depends on the parent group and the parent group depends on the child query).e.Parent Group
Description The Parent Group property is the name of the group defined as the parent when you created the link in the Data Model view. however.
Parent Group restrictions
n A Parent Group cannot have the Child Query as one of its ancestors. all of the detail records will appear for each master record in the parent group. This field is read-only..

Default WHERE Usage Notes
n If you use a SQL Clause of START WITH. see the ORACLE8 Server SQL Language Reference Manual. For details.SQL Clause
Description The SQL Clause property is the type of clause that relates the parent group to the child query. then the SELECT Statement of the Child Query should contain a GROUP BY clause (without a HAVING clause.
286
Report Builder Reference
. Values HAVING START WITH WHERE Applies to links Required/Optional required. since that is contained in this property). if Parent Column(s) is specified. since that is contained in this property). if you use a SQL Clause of HAVING. Similarly. then the SELECT Statement of the Child Query should contain a CONNECT BY clause (without a START WITH clause.

A group called Group3 contains a column called SUMSAL.Cross Product Group
Description The Cross Product Group property is the group that contains the source groups of the Horizontal and Vertical Repeating Frames. The Cross Product Group is Group4 (the group that is the parent of Group1 and Group2). Job Analyst Clerk Manager 10 $1300 $2450 Dept 20 $6000 $1900 $2975 30 $ 950 $2850 In this example:
n n n
The Vertical Repeating Frame is the repeating frame that contains Group2 (the job titles). The matrix might then look something like the one below. which gets its values from the database column DEPTNO. Job Loc Dept Analyst Clerk Manager New York 10 $1300 $2450 Dallas 20 $6000 $1900 $2975 Chicago 30 $ 950 $2850
288
Report Builder Reference
. Applies to matrices Required/Optional required Default blank
Matrix example
Suppose that you have a group named Group1 that contains a column called C_DEPTNO. contains column C_JOB. A group called Group2. which is a summary of the database column SAL. and column C_DEPTNO1. you can do so by adding more columns to Group1 and Group2. instead of having Group1 just contain department numbers. The cross product group correlates values between one or more groups to produce the data in the matrix. For example.
If you need to build a more complex matrix. The Horizontal Repeating Frame is the repeating frame that contains Group1 (the department numbers). which gets its values from the database column JOB. it could also contain the locations (LOC) of the departments. which is used for linking to Group1’s query. Values Enter a valid cross product group name.

Matrix restrictions
n n
The down repeating frames must be below the across repeating frames in a matrix. A matrix object cannot be anchored to another object and other objects cannot be anchored to it (i.e.. it must be one or more layers above its horizontal and vertical repeating frames). You can put a border on a matrix object just as you would any other object. As a result. the repeating frames associated with such groups must print in the same direction on the page. Repeating frames whose source groups are in the same "family" hierarchy (i.e. only the repeating frame is placed in the paste buffer. If you select the matrix and one of the repeating frames. you must select the matrix and its two repeating frames. Moving a matrix also causes its two repeating frames to move. A matrix object can only be resized by resizing its associated repeating frames. You cannot use Align. Parentchild relationships within a cross-product group are used to create nesting in the matrix. nothing will be copied to the paste buffer. The source groups of the repeating frames that make up the dimensions of a matrix must be from the same cross-product group.. or Size Objects from the Arrange menu on matrix objects. but the width will always be the minimum width possible. To copy a matrix. are descendants or ancestors of each other) must have the same Print Direction.e. If you select the matrix by itself. Report Builder prevents you from moving the matrix below its horizontal and vertical repeating frames. a matrix object cannot be the parent or child object for an anchor). A matrix object must always be on top of the repeating frames that form it (i.. Align Objects.
n n
n
n n n n
n
Report Builder Reference
289
. You cannot widen the border due to the closeness of the objects in a matrix layout.

Applies to matrices Required/Optional required Default blank
Horizontal and Vertical Repeating Frame restrictions
n
The source groups of the repeating frames specified in the Horizontal and Vertical Repeating Frame properties must be within the same cross-product group. and help compute the cross product for the matrix. Values Enter any valid repeating frame name.
290
Report Builder Reference
.Horizontal Repeating Frame
Description The Horizontal Repeating Frame property is the repeating frame whose values produce the row headings and summaries.

Is the number of report copies that should be made when the report is printed. landscape mode for a printer). printer. file. to create PDF or HTML output). Is the print direction for the report (landscape. Is whether the Print Job dialog box should appear before the report is run. "$"). mail userid). Is the definition of the output device’s format (e. Is the symbol for the thousand’s indicator (e.g. ". printer’s name... Is whether the report should run in character mode or bitmap. Is the symbol for the decimal indicator (e. Is the name of the output device (e. Is the symbol for the currency indicator (e.").g. or screen using PostScript format)."). and when sending a bitmap report to a file (e. Is the type of device to which to send the report output (screen.g. This parameter is used when running a report in a character-mode environment. portrait. ".g..System Parameters
BACKGROUND COPIES CURRENCY DECIMAL DESFORMAT Is whether the report should run in the foreground or the background.g. mail..
DESNAME DESTYPE
MODE ORIENTATION PRINTJOB THOUSANDS
Report Builder Reference
295
.. default).g. the file name.

Applies to parameters Required/Optional required.Add
Description The Add button places the value in the Value field to the list of static values. if you want to add to the static values
296
Report Builder Reference
.

you could describe the purpose of the parameter so that someone else would be able to quickly understand what it does. For example. Enter any text not to exceed 64K. Applies to parameters Required/Optional optional Default blank
298
Report Builder Reference
.Comment
Description The Comment property contains text that documents the parameter.

Report Builder Reference
299
. even at runtime. n Parameters with a Datatype of Character are not padded.. Values Character Date Number Applies to parameters Required/Optional required Default Character
Datatype restrictions
n Any values supplied for a parameter must conform to the parameter’s Datatype. numbers).Datatype
Description The Datatype property is the type of values the parameter contains (e..g. n Datatype cannot be edited for packaged parameters (e. DESTYPE). unless you explicitly pad them in a SQL statement.g.

300
Report Builder Reference
. they only know them by name. The tables you will be using have DEPTNO as the primary/foreign key. Only DNAME will appear. When the user selects a DNAME value from the list. This means that DEPTNO will not appear in the list of values when you run the report.Hide First Column
Description The Hide First Column property is a check box that indicates whether the first column in your SELECT list should be displayed in the parameter’s list of values. you choose SELECT Statement and enter the following SQL statement to populate the list of values:
SELECT DEPTNO. the corresponding DEPTNO value will be used for the parameter MYDEPT. The report query would be as follows:
SELECT * FROM EMP WHERE DEPTNO = :MYDEPT
In the Data/Selection tab of the Parameter property sheet. The people using the report do not know departments by number. DNAME FROM DEPT
You then check Hide First Column. This setting is useful for hiding values that the user does not know about or are confidential. Applies to parameters Default checked
Hide First Column example
You want to create a report that lists the employees in a department that the user specifies at runtime.

blank.) n If no value is specified and the parameter is referenced in SQL or PL/SQL.Initial Value
Description The Initial Value property is the default value for the parameter. This value is used unless it is overridden on the command line or the Runtime Parameter Form. Applies to parameters Required/Optional optional Default For DESTYPE. the parameter has no default value. In addition.
Initial Value restrictions
n Initial Value is validated according to the Datatype and Width of the parameter. Enter any value appropriate for the Datatype of the parameter. n If Format Mask is blank and the value is a date. dflt. Screen. the mask in Format Mask is used. Initial Value cannot exceed 1K in length.
Report Builder Reference
301
. 1. (Number and character values are not validated unless you specify a Format Mask. Report Builder’ internal mask (e. If a null causes the SQL or PL/SQL construct to parse incorrectly. DD-MON-YY) is used. For all other parameters..g. an error will be raised. If Initial Value is left blank. For DESFORMAT. Initial Value is validated against format masks: n If you specify one. For COPIES. a null is used to parse the SQL or PL/SQL.

the Input Mask is -9999.g. only number masks are shown in the list). the list of values will not contain the format masks you created in the previous Report Builder session (unless you open the report(s) that used these masks). Enter any valid format mask not to exceed 128 bytes or select a value from the list. To add new format masks to the list that will be saved between sessions. use the Edit Masks button in the Preferences dialog.. the Input Mask is the default for your language (e. for a parameter of Datatype Number. It is also used to validate the Initial Value of the parameter. and when the Datatype is Number. n The Input Mask property does not apply to parameters of Datatype Character. If you quit Report Builder and then invoke it again. the new value will appear in the list..
Input Mask restrictions
n The values displayed initially in Input Mask list of values are determined by the datatype of the parameter (e. these format masks are only valid during the current Report Builder session. in the United States. the default is ’DD-MON-YY’).
302
Report Builder Reference
.g.Input Mask
Description The Input Mask property is the format mask Report Builder uses to validate the value supplied for the parameter on the command line or the Runtime Parameter Form. If you enter a new format mask and accept the property sheet. This implies that when the Datatype is Date. However. Applies to parameters Required/Optional optional Default blank.

the name that you used in the query is the default.
Report Builder Reference
303
.
Name restrictions
n You cannot rename system parameters. Applies to parameters Required/Optional required Default P_n. Enter any valid parameter name not to exceed 30 bytes. though.Name
Description The Name property is the name that Report Builder uses to identify the current parameter. If you create a parameter by making a bind reference in your query. where n is a number that is unique among column names for the report.

an error will be generated when you accept the Parameter property sheet. Applies to parameters Default checked
Report Builder Reference
305
. if you set a value for the parameter on the command line or in a command script and it does not match a value in the list of values. a list of values will appear in the runtime parameter form. you can enter values as well as select from the list).e. If you check Restrict List to Predetermined Values.. if you check Restrict List to Predetermined Values and the Initial Value does not match a value in the list of values. a combo box will appear (i. For example. Similarly. an error will be generated when the report is run. If you do not check it.Restrict List to Predetermined Values
Description The Restrict List to Predetermined Values is a checkbox that indicates whether a value for the parameter must be in the list of values.

Values SELECT Indicates that you want to enter a SELECT statement to Statement populate the list of values for the parameter.SELECT Statement/Static Values
Description The SELECT Statement/Static Values property is a radio button that indicates whether you want to use a SELECT (SQL query) statement or a static list to populate the list of values for the parameter. To remove value(s). select them in the list and then choose the Remove button. Repeat this process for each value you want in the list. To do this. If you select this option. Applies to parameters Required/Optional required
306
Report Builder Reference
. Static List Indicates that you want to manually enter values to populate the list of values for the parameter. If you select this option. you must create a list of values manually. you enter a value in the Value field and then choose the Add button. then you must enter a SELECT statement in the area underneath the SELECT Statement radio button.

modify the parameter.Validation Trigger
Description The Validation Trigger property is a button that displays the PL/SQL Editor in which you can enter PL/SQL to validate and. if necessary. Applies to parameters
Report Builder Reference
307
.

308
Report Builder Reference
. Enter a valid value for the parameter and then choose the Add button to add it to the static list of values. if you want to add a value to the static list. Applies to parameters Required/Optional required.Value
Description The Value property is a value that will be added to the static list of values for the parameter when you choose the Add button.

g. Applies to parameters Required/Optional required Default 40 characters
Width restrictions
n Report Builder truncates any parameter value supplied at runtime that is longer than Width. n Width cannot be edited for packaged parameters (e.
Report Builder Reference
309
. Enter a number from 1 through 64K. DESNAME).Width
Description The Width property is the maximum number of characters of the parameter value when entered on the command line and the Runtime Parameter Form..

Name
Description The Name property is the name that Report Builder uses to identify the current boilerplate.
312
Report Builder Reference
. Values Enter any valid parameter form boilerplate name. where n is a number that is unique among parameter form boilerplate names for the report. Applies to parameter form boilerplate Required/Optional required Default PB_n.

This field is read-only.Type
Description The Type property displays the format (e..
Report Builder Reference
313
.g. text) of the boilerplate object.

Report Builder Reference
315
.Datatype
Description The Datatype property is a read-only field that displays the datatype of the parameter form field’s Source.

Values Enter any valid parameter form field name. Applies to parameter form fields Required/Optional required Default PF_n. where n is a number that is unique among parameter form field names for the report.
316
Report Builder Reference
.Name
Description The Name property is the name that Report Builder uses to identify the current field.

Report Builder Reference
317
. Applies to parameter form fields Required/Optional required Default blank
Source restrictions
n n
The Source of a parameter form field must be a data model parameter. You cannot specify more than one parameter form field with the same Source. Values Enter any valid parameter name.Source
Description The Source property is the parameter from which the parameter form field gets its value. The list of values contains all parameters in the report.

00 Dname RESEARCH Loc DALLAS Highest Paid Employee(s): Ename Job Sal ---------.--------SMITH CLERK 800.--------CLARK MANAGER 2450.00 ADAMS CLERK 1100.00 FORD ANALYST 3000. The output below shows a sample of what you would get: Dname ACCOUNTING Loc NEW YORK Highest Paid Employee(s): Ename Job Sal ---------. and Date.Placeholder Column properties
Break Order Column Type Comment Datatype File Format Name PL/SQL Formula Product Order Read from File Set Break Order Value If Null Width
Placeholder Column restrictions
n You can set placeholder or formula columns to any of the following Datatypes: Character.--------.00 SCOTT and FORD JONES MANAGER 2975.00
318
Report Builder Reference
. n You can only assign the value of a placeholder column from one group. You cannot assign its value in multiple groups.00 SCOTT ANALYST 3000.00 MILLER CLERK 1300.
Placeholder for Special Summary example
Suppose that you wanted to create a master/detail report that would list the highest paid employee(s) for each department.00 KING KING PRESIDENT 5000. Number.--------.

we have more than one max sal) set the placeholder to the concatenated string. return (:highest_paid_emp). else :highest_paid_emp := :ename. Else set the placeholder to the employee’s name */ if (:sal = :max_dept_sal) then if (:highest_paid_emp <> ’ ’) then :highest_paid_emp := :highest_paid_emp||’ and ’ ||:ename. end if.To get the names of the highest paid employee(s). end if. The value of HIGHEST_PAID_EMP is set by a formula column named SET_HIGHEST_PAID_EMP of Datatype Character. end.
Report Builder Reference
319
. SET_HIGHEST_PAID_EMP contains the following PL/SQL function in Formula:
function set_plch_high_emp return character is begin /* Check if we are at first record in child.e. if so. end if. you create a placeholder column named HIGHEST_PAID_EMP of Datatype Character. /* Does this child record compare to the max sal for the dept ? If yes. then reset placeholder */ if (:r_count <= 1) then :highest_paid_emp := ’ ’. R_COUNT is a summary column with a Function of Count. and placeholder already set (i.

PL/SQL Formula
Description The PL/SQL Formula property is a button that displays the PL/SQL Editor in which you can enter your formula. Applies to formula and placeholder columns
320
Report Builder Reference
.

Alphabetical list of properties
Add Additional Hyperlink Attributes After Form Type After Form Value After Page Type After Page Value After Report Type After Report Value Align Summaries with Fields Alignment Application Command Line (PDF) Background Color Base Printing On Before Form Type Before Form Value Before Page Type Before Page Value Before Report Type Before Report Value Between Field and Labels (Horizontal) Between Frame and Fields (Horizontal) Between Frame and Fields (Vertical) Between Master and Detail (Horizontal) Between Master and Detail (Vertical) Between Page and Frames (Horizontal) Between Page and Frames (Vertical) Between Sibling Frames (Horizontal) Between Sibling Frames (Vertical) Bookmark Borders Break Order Character Justification Chart Column Chart Filename Chart Hyperlink Chart Parameter Chart Query Child Column Child Edge Percent
Report Builder Reference
321
.

/* comment */). you could describe the purpose of the query so that someone else would be able to quickly understand what it does. Applies to queries Required/Optional optional Default blank Usage Notes
n You can also insert comments directly into your SQL SELECT statement using Oracle’s standard SQL comment delimiters (e. For example.g.Comment
Description The Comment property contains text that documents the query.
Report Builder Reference
327
. Enter any text not to exceed 64K.. For more information. see the ORACLE8 Server SQL Language Reference Manual .

. external queries. If you update the external query source file. Report Builder uses its file path search order to find the file. and PL/SQL). it will not be able to find the query and will issue a message to that effect. The external query source file you reference cannot exceed 32K in length. For example: DB:myquery If you prefix DB: to the query name. If a path is not prefixed to the filename. you must ensure that the update does not invalidate the report definition. For example. you can take advantage of the environment variable called REPORTS30_PATH.g. If it does. you can prefix DB: to it to indicate that it is stored in the database. You can use this variable to specify the default directory or directories where you want to search for external files you use in your reports (e. you must open the external query source file. If the query is stored in a file. the SELECT statement of the external query appears in the SQL Query Statement field as read-only. boilerplate. you can prefix a path to the query name. Note: To ensure the portability of your reports. if the report has a column for DEPTNO and you delete DEPTNO from the SELECT list of the external query source file. it will be truncated and a warning raised.External Query Source File
Description The External Query Source File property is the name of a query stored in the database or a file whose SELECT statement should be used as the SELECT statement for the current query. If the query is stored in the database. Applies to queries Required/Optional optional Default blank Usage Notes
n n
The SELECT statement of the external query source file you reference from this field is validated when you accept the query’s property sheet. This prevents the need to hardcode directory paths in your report. When you specify an external query source file name. the report cannot run. the Report Builder will go directly to the database to find the query. Enter a valid external query source file name not to exceed 1K. To modify it.
n
328
Report Builder Reference
. If you are not connected to the database.

Report Builder Reference
329
. Report Builder will only retrieve the number of rows for the query that you specify in this property. If left blank. Values A whole number from 1 through 32K means that only that number of rows will be retrieved . you often must run it many times to see how it looks. if you set Maximum Rows to Fetch to 5 on a child query.Maximum Rows to Fetch
Description The Maximum Rows to Fetch property is the maximum number of rows of data that the query should retrieve. this can be very time consuming. When you are designing a report. use Filter in the Group property sheet. of a query’s groups. but not all. This property can improve performance by reducing the amount of data retrieved and formatted. Applies to queries Required/Optional optional Default blank Usage Notes
n
Rows that were not retrieved because they were beyond the maximum will not be used in any Report Builder-specified calculations.SET MAXROW procedure. For example. all rows are retrieved. then a summary of the child contained in the parent group will only use the five records that are retrieved by the query. If your report retrieves a lot of data. If you want to use data in calculations but not have it appear in the report output. To restrict the rows retrieved by some.
PL/SQL To define this attribute using PL/SQL. use the SRW. use a Format Trigger to restrict what appears in the output.

where n is a number that is unique among query names of the report.
330
Report Builder Reference
. Applies to queries Required/Optional required Default Q_n. Enter a valid name not to exceed 30 bytes.Name
Description The Name property is the identifier that Report Builder uses to refer to the current query.

ORDID AND I.ORDID) of the */ /* order in which they bought the product. O. you can do the following:
n n n n
use the Tables and Columns dialog box insert comments insert bind and lexical references review SQL errors
Applies to queries Required/Optional required
SQL Query statement example
Following is an example of a SELECT statement:
SELECT O. ITEM I WHERE O. P.PRODID ORDER BY O. In building your SELECT statement.DESCRIP. you will get an error because the statement has no table name after FROM.CUSTID. I.ITEMTOT. except the INTO and FOR UPDATE clauses.SQL Query Statement
Description The SQL Query Statement property is a SQL SELECT statement that retrieves data from the database for your report. you must define a parameter named FROMGROUP with an Initial Value specified. O.ORDERDATE /* For each customer.ORDERDATE. The upper limit may vary between operating systemsAll features of the SELECT statement are supported.and the order id (ITEM. the date they ordered the product */ /* (ORDERDATE).PRODID.
Report Builder Reference
331
.PRODID = P.ORDID = I. PRODUCT P. Note that. */
SQL Query statement with bind and lexical references example
Following is an example of a SELECT statement that uses bind and lexical references:
SELECT CUSTID. the amount they spent on that product */ /* (ITEMTOT).ORDID FROM ORD O. SUM(TOTAL) TOTAL FROM &FROMGROUP HAVING SUM(TOTAL) > :MINTOTAL
where: &FROMGROU P
Is ORD GROUP BY CUSTID (or some other value that you enter at runtime). in this case.CUSTID. show the products they bought */ /* (DESCRIP). Enter a valid SELECT statement not to exceed 64K. P. I. If the value of &FROMGROUP is null when the SELECT statement is parsed.

renamed in. Report
n n n
n
332
Report Builder Reference
. since that is in the data model link). and placeholders whose source columns have increased in width must have their own widths updated manually. from the command line. If SELECT expressions are added to. For example. truncation may occur. or deleted from a query. since that is in the data model link). Database columns are automatically updated when the query is re-parsed (e.
n
The SELECT statement must follow all SQL syntax rules. a query that is the child in a link with a SQL Clause of HAVING should contain a GROUP BY clause in its SQL Query Statement (without a HAVING clause.. Similarly.g. you need to update both the data model and the layout model to reflect the change. fields in the layout must be resized or have their sizing settings changed to accommodate the increased size of their source columns. Otherwise.
SQL Query statement with lexical reference example
Following is an example of a SELECT statement that uses a lexical reference to a parameter:
SELECT ENAME. enter a space in SQL Query Statement and click OK). Similarly. or any other character should be used to end the SELECT statement. Summaries. formulas. EMPNO FROM EMP WHERE ENAME LIKE UPPER (&NAME)
where: &NAME
Refers to a parameter with a default value of ’JO%’. you could type: RWRUN60 REP SCOTT/TIGER NAME=’SM%’
SQL Query Statement restrictions
Caution: If the width of a column in the database is increased after you have created your report. Report Builder checks the syntax when you leave SQL Query Statement and when the report is generated or executed. You must have the appropriate privileges on the tables and views referenced in the SELECT statement in order for the SELECT statement to be validated. No semicolon. For details. slash.:MINTOTAL
Is a column from another query that is used to select customers with a minimum total of orders. A query that is the child in a link with a SQL Clause of START WITH should contain a CONNECT BY clause in its SQL Query Statement (without a START WITH clause. Note that you can also specify a value for the parameter at runtime. see the ORACLE8 Server SQL Language Reference Manual .

Subsequent changes to the order of columns in the SELECT statement will not change the order of the columns. If you add new columns to the SELECT statement..Builder automatically creates or deletes the corresponding columns.e.
n
If you make any changes in the database to the datatype or name of columns that are selected by your query. they will be added at the end of the lowest child group belonging to the query. you must manually make whatever changes are necessary to the Report Builder columns and fields that use the changed column as a Source.
n
Report Builder Reference
333
. The order of the columns is used to order the associated fields in the default layout. The reason Report Builder does not update the layout model for you automatically is that you could inadvertently lose any modifications you have made to the default layout. The order of the columns in the SELECT statement determines the initial column order. You must update the affected objects in the Layout Model view manually or create a new default layout for the report. layout model contains objects). If the layout has been defined (i. Report Builder will not update the layout model based upon changes to the SELECT statement.

Applies to queries
334
Report Builder Reference
.Type
Description The Type property is a read-only field that describes the type of query.

See the online help for details and illustrations.e. the next instance cannot begin formatting before the previous instance is completed. elasticity is Variable or Expand).Column Mode
Description The Column Mode property controls how Report Builder fetches and formats data for instances of repeating frames.
Column Mode restrictions
n You can only specify Column Mode for repeating frames that have either: n Print Direction of Across and Horizontal Elasticity of Fixed n Print Direction Down and Vertical Elasticity of Fixed n
Repeating frames with a Print Direction of Across/Down or Down/Across cannot have Column Mode specified.. Applies to repeating frames Required/Optional optional Default No
Column Mode example
See the online help for details and illustrations. With Column Mode set to Yes.
Report Builder Reference
337
. Column Mode is used mainly for master repeating frames or repeating frames that contain fields that may expand vertically or horizontally (i. See the online help for details and illustrations. the next instance of a repeating frame can begin formatting before the previous instance is completed. With Column Mode set to No.

Enter a number of zero or more. the maximum is 512 inches. n
When the Print Direction is Down/Across. Space Between Frames property is the amount of space (in the report’s unit of measurement) that you want horizontally between instances of the repeating frame.312 centimeters. Applies to repeating frames Required/Optional required Default 0
Horiz. The maximum amount depends upon the unit of measurement.
338
Report Builder Reference
. it is 1. Space Between Frames
Description The Horiz. For inches. For picas.Horiz. this setting has no effect. Space Between Frames restrictions
n When the Print Direction is Down. See the online help for details and illustrations. it is 36.864 picas. For centimeters. this setting affects space between instances that appear one next to the other.

Then. specify Page Break Before and Page Break After. To improve the appearance of your report. you set Maximum Records Per Page to 3.
Report Builder Reference
339
. Applies to repeating frames Required/Optional optional Default blank
Maximum Records Per Page example
Suppose that you want each instance of a repeating frame to be on a logical page by itself. Values a whole number from 1 through 32K Means that number of instances is the maximum that can be formatted on a logical page. Suppose that you have a repeating frame with many instances.Maximum Records Per Page
Description The Maximum Records Per Page property is the maximum number of instances of the repeating frame that will be formatted on a logical page. First. To ensure that you never have more than three instances per logical page. you prefer to have at most three instances of the repeating frame on a given logical page. blank Means that as many instances of the repeating frame as possible can be formatted on a logical page. set Maximum Records Per Page to 1 for the repeating frame so that only one instance appears on each logical page. to make sure that the first instance of the repeating frame starts on a new logical page.

Instead. none will be formatted on that page. If the number of instances specified for this property cannot fit on the logical page where the repeating frame is initially triggered to print. 1 means that there is no minimum. they are all formatted on the next logical page.
Minimum Widow Records restrictions
n Minimum Widow Records applies only to the first logical page on which the object is triggered to be printed.Minimum Widow Records
Description The Minimum Widow Records property is the minimum number of instances that should appear on the logical page where the repeating frame starts to print.
340
Report Builder Reference
. If not all instances can fit on the first logical page where the repeating frame is triggered to print. that on the next and all subsequent pages. if all instances cannot fit on that logical page. n If Minimum Widow Records is greater than the total number of instances of the repeating frame. then the repeating frame will start formatting on the next page. though. Notice. Since you are starting with a fresh page. If set to 1. Suppose that to improve the appearance of your report. Applies to repeating frame Required/Optional required Default blank
Minimum Widow Records example
Suppose that you want all instances of a repeating frame to appear on one logical page. you set Minimum Widow Records to a very large number. To make sure that there are at least two instances on the logical page. the repeating frame will start formatting on the next page. blank Means that there is no minimum. by itself. If all instances cannot fit on the first logical page where the repeating frame is triggered to format. there is no minimum and the repeating frame will start formatting on any logical page that can fit one instance. To do this. then all instances must be able to fit on the first logical page where the repeating frame is triggered to format. you set Minimum Widow Records to 2. Minimum Widow Records is ignored on subsequent pages. they will not all fit on any one logical page anyway. Minimum Widow Records is ignored. Values a whole number from 1 through 32K Means that number of instances is the minimum that can be formatted on a logical page. you want to make sure that you do not have the first instance of the repeating frame printed at the bottom of a logical page.

a graphic) on a page that prevented two instances of the repeating frame going across the page. Across/Down Means that each instance of the repeating frame subsequent to the first instance is printed to the right of the previous instance until an entire instance cannot fit between the previous instance and the right margin of the logical page. Report Builder prints the instance below the left-most instance on the logical page.g. Down/Across Means that each instance of the repeating frame subsequent to the first instance is printed below the previous instance until an entire instance cannot fit inside the bottom margin of the logical page. Instances of the repeating frame print from left to right and then top to bottom. At that time. At that time.
Print Direction restrictions
n If a nested repeating frame has a Print Direction of Across and its enclosing
Report Builder Reference
341
. provided there is enough vertical space left on the logical page for the instance to print completely. the repeating frame instances begin printing across and then down. provided there is enough horizontal space left on the logical page for the instance to print completely. Values Across Means that each instance of the repeating frame subsequent to the first instance is printed to the right of the previous instance across the logical page. Report Builder prints the instance to the right of the topmost instance on the logical page. If. Where there is room to print more than one instance across the page. See the online help for details and illustrations.Print Direction
Description The Print Direction property is the direction in which successive instances of the repeating frame appear. Applies to repeating frames Required/Optional required Default Down
Print Direction example (across/down)
Suppose that you have a repeating frame with Print Direction of Across/Down. however. See the online help for details and illustrations. there was an object (e. the repeating frame instances would only print down the page.. Down Means that each instance of the repeating frame subsequent to the first instance is printed below the previous instance down the logical page.

As a result. the across repeating frame can cause overflow when it is too wide for the current page. down repeating frame will not print until the previous instances of the across repeating frame completes..
342
Report Builder Reference
.repeating frame has a Print Direction of Down. the repeating frames associated with such groups must print in the same direction on the page. See the online help for details and illustrations. Parent-child relationships within a crossproduct group are used to create nesting in the matrix. The next instance of the outer. you could use Column Mode. Note: If you wanted A3 on page 1 to be aligned with the overflow of A3 on page 2.
n Matrix dimension repeating frames whose source groups are in the same "family" hierarchy (i. are descendants or ancestors of each other) within a cross-product group must have the same Print Direction.e.

Source
Description The Source property is the group that owns the data for the repeating frame. Applies to repeating frames Required/Optional required Usage Notes
n Source cannot be a cross-product group. Select any valid group name.
Report Builder Reference
343
.

The maximum amount depends upon the unit of measurement. For picas. n When the Print Direction is Across/Down. it is 1. this setting determines the space between instances that appear one below the other. it is 36. For centimeters. Enter a number of zero or more.312 centimeters. Applies to repeating frames Required/Optional required Default 0
Vert. this setting has no effect. For inches.Vert. See the online help for details and illustrations. Space Between Frames restrictions
n When the Print Direction is Across.864 picas. Space Between Frames
Description The Vert. Space Between Frames property is the amount of space (in the report’s unit of measurement) you want vertically between instances of the repeating frame. the maximum is 512 inches.
344
Report Builder Reference
.

Report properties
After Form Type After Form Value After Page Type After Page Value After Report Type After Report Value Before Form Type Before Form Value Before Page Type Before Page Value Before Report Type Before Report Value Comments Design in Character Units Direction Disable Host Menu Item Disable Split Screen Key Disable Zoom Key Distribution Height (Parameter Form Window) Include Borders Include Bitmapped Objects Max. Horizontal Body Pages Max. Vertical Body Pages Name Number of Pages Page Navigation Control Type Page Navigation Control Value Panel Print Order Previewer Hint Line Text Previewer Status Line Text Role Name Suppress Previewer Title Start in Zoom Previewer Title Unit of Measurement Use Previewer Hint Line Use Previewer Status Line Width (Parameter Form Window)
Report Builder Reference
345
.

Unit of Measurement
Description The Unit of Measurement property is the standard of measure used to specify the dimensions of the report and the parameter form. Values Centimeter Inch Point Is a printer’s type size that makes up a pica. Each pica contains twelve points and is equivalent to one-sixth of an inch. Applies to reports Required/Optional required Default Inch

346

Report Builder Reference

Max. Horizontal Body Pages
Description The Max. Horizontal Body Pages property is the maximum number of body pages in width you want to appear in your report. Values Any whole number from 1 through 999. Applies to reports Required/Optional required Default 10

Report Builder Reference

347

Max. Vertical Body Pages
Description The Max. Vertical Body Pages property is the maximum number of body pages in height you want to appear in your report. Values Any whole number from 1 through 999. Applies to reports Required/Optional required Default 10

348

Report Builder Reference

Panel Print Order
Description The Panel Print Order is the order in which the physical pages comprising a logical page should be printed. It also determines the order in which panels are numbered within the logical page. The figure illustrates logical pages, physical pages, and panels. See the online help for details and illustrations. Values Across/Down Means the physical pages of the report body will print leftto-right then top-to-bottom. Down/Across Means the physical pages of the report body will print topto-bottom and then left-to-right. Applies to reports Required/Optional required Default Across/Down

Report Builder Reference

349

Direction
Description The Direction property enables you to specify the reading order for the entire report. The value of Direction serves as the default for layout objects in the report (e.g., fields, boilerplate, etc.). It also controls the orientation of the Report Editor (e.g., if Direction is Right to Left, the orientation of the Report Editor will be right to left). This means you do not have to move objects manually to simulate a right to left orientation in the Report Editor. Values Left to Right Right to Left Applies to reports Required/Optional required Default The natural writing direction of the language.

Direction restrictions
n
Changing the direction of the report or any object only takes effect when running on a bi-directional platform.

350

Report Builder Reference

Distribution
Description The Distribution property uses the values specified in the Distribution dialog box to define a distribution for the entire report. Applies to reports Required/Optional optional

Report Builder Reference

351

Previewer Title
Description The Previewer Title is the text that appears at the top of the report in the Live Previewer view. To change the default title, type the desired text in the field provided. Values Enter an alphanumeric string not to exceed 256 bytes. You can restore the default title by deleting whatever title text you entered yourself. Applies to reports

352

Report Builder Reference

Role Name
Description The Role Name property specifies the database role to be set for the report at runtime. You can use this option to give end users the ability to run reports that query database tables to which they do not normally have access privileges. Reports Runtime can only set a role that is granted in the database. If Reports Runtime cannot set a role, it will not run the report. Values Enter a valid database role, not to exceed 30 characters. Applies to reports Required/Optional optional Default The default role(s) specified for the user in the database, which are set when the user connects to the database. Usage Notes

n

You can set the Role Name property in the Property Palette for the Report; to (optionally) set a Role Password, double-click the button in the Role Name value field to display the Set Role dialog. If you specify a role using the command line with Reports Runtime (RWRUN60), it overrides the role settings in the report. You can set only one role for a report. To set multiple roles, you need to set a role to which the other roles have been granted.

n n

Role Name restrictions
n
Setting a role in a PL/SQL trigger can cause conflicts, and is not recommended.

Report Builder Reference

353

Width (Parameter Form window)
Description The Width property is the width of one parameter form page in the Unit of Measurement. Values Enter a valid width of zero or more. The maximum width depends upon the Unit of Measurement. For inches, the maximum width is 512 inches. For centimeters, it is 1,312 centimeters. For points, it is 36,864 points. Applies to reports Required/Optional required Default 4 inches or 10 centimeters or 300 points

Width (Parameter Form window) restrictions
n
If you change the Unit of Measurement after you have already specified the Width, the Width will change automatically to the approximate width in the new Unit of Measurement.

354

Report Builder Reference

Height (Parameter Form window)
Description The Height property is the height of one parameter form page in the Unit of Measurement. Values Enter a valid height of zero or more. The maximum height depends upon the Unit of Measurement. For inches, the maximum height is 512 inches. For centimeters, it is 1,312 centimeters. For points, it is 36,864 points. Applies to reports Required/Optional required Default 4 inches or 10 centimeters or 300 points

Height (Parameter Form window) restrictions
n
If you change the Unit of Measurement after you have already specified the Height, the Height will change automatically to the approximate height in the new Unit of Measurement.

Report Builder Reference

355

Number of Pages
Description The Number of Pages property is the total number of pages you want in your Runtime Parameter Form. Values Any whole number from 1 through 9,999. Applies to reports Required/Optional required Default 1

You can click the value field (labeled …) to modify the default built-in JavaScript as desired. myreport). depending on what you specified for Page Navigation Control Type. Values Any valid filename or a text string containing valid HTML commands. use the SRW. PL/SQL To define this attribute using PL/SQL. If you want to use icons and images in this frame. you must include two variables in your script:
n n
&TotalPages (total number of pages) &file_name (the name of the output destination file. e.. Applies to HTML or HTMLCSS page-streamed report output Required/Optional optional Default Report Builder built-in JavaScript Usage Notes If you choose to provide your own script for navigation controls.g.
358
Report Builder Reference
. keep these dimensions in mind.SET_PAGE_NAVIGATION_HTML procedure. The height of the page navigation control frame is hard coded to 70 points without a scroll bar.
Report Builder assigns values to these variables during formatting.Page Navigation Control Value
Description The Page Navigation Control Value property specifies the filename or scripting code for the navigation buttons in HTML page-streamed report output. The width of the frame is variable.

SET BEFORE REPORT HTML procedure. File Is any valid text or graphics file. background color or images. use the SRW.
Report Builder Reference
359
. if you specified a Before Report Value. Values Text Is any text string containing valid HTML commands.Before Report Type
Description The Before Report Type property specifies the type of header to appear at the beginning of your document when the report is output to an HTML file and viewed in a Web browser. this property applies to the first page of your report output. Default Text PL/SQL To define this attribute using PL/SQL. or any other <body> HTML attributes).. If you use HTML page streaming. To specify HTML to apply to the entire report (e. Applies to reports Required/Optional Required. you must use the Before Page properties.g.

If you use HTML page streaming.g. To specify HTML to apply to the entire report (e.Before Report Value
Description The Before Report Value property specifies a header to appear at the beginning of your document when the report is output to an HTML file and viewed in a Web browser. background color or images.
PL/SQL To define this attribute using PL/SQL. this property applies to the first page of your report output. you must use the Before Page properties.
360
Report Builder Reference
. depending on what you specified for Before Report Type.. Applies to reports Required/Optional Required. if you specified a Before Report Type of File. or any other <body> HTML attributes).
Before Report Value restrictions
n
If you replace the default text. Values Any valid filename or a text string containing valid HTML commands. use the SRW. Default The default HTML commands included at the beginning of a report: <html> <body bgcolor="#ffffff"> Usage Notes
n
This property is useful for placing a logo or some standard links at the beginning of an HTML document.SET BEFORE REPORT HTML procedure. you must ensure that it contains the equivalent HTML commands.

or any other <body> HTML attributes). Default Text PL/SQL To define this attribute using PL/SQL. use the SRW.
Report Builder Reference
361
. you must use the Before Page properties. this property applies to the last page of your report output. background color or images. If you use HTML page streaming.g. File Is any valid text or graphics file. Applies to reports Required/Optional Required. Values Text Is any text string containing valid HTML commands.SET AFTER REPORT HTML procedure. To specify HTML to apply to the entire report (e..After Report Type
Description The After Report Type property specifies the type of trailer to appear at the end of your document when the report is output to an HTML file and viewed in a Web browser. if you specified an After Report Value.

If you use HTML page streaming. depending on what you specified for the After Report Type. Applies to reports Required/Optional Required. this property applies to the last page of your report output..
After Report Value restrictions
n
If you replace the default text. background color or images. To specify HTML to apply to the entire report (e. use the SRW.g. if you specified an After Report Type of File.
PL/SQL To define this attribute using PL/SQL. Values Any filename or a text string containing valid HTML commands. or any other <body> HTML attributes).SET AFTER REPORT HTML procedure. Default The default HTML commands included at the end of a report: </body></html> Usage Notes
n
This property is useful for placing a logo or some standard links at the end of an HTML document.
362
Report Builder Reference
. you must use the Before Page properties. you must ensure that it contains the equivalent HTML commands.After Report Value
Description The After Report Value property specifies a trailer to appear at the end of your document when the report is output to an HTML file and viewed in a Web browser.

Values Text Is any text string containing valid HTML commands. background color or images.Before Page Type
Description The Before Page Type property specifies the type of header to appear at the beginning of each page of your document when the report is output to an HTML file and viewed in a Web browser.g.
Report Builder Reference
363
. Applies to reports Required/Optional Required. Default Text PL/SQL To define this attribute using PL/SQL. use the SRW. respectively. If you use HTML page streaming. if you specified a Before Page Value. To specify HTML for only the first (header) or last (footer) pages of your report. this property applies to all pages of your report output (e.SET BEFORE PAGE HTML procedure. use the Before Report or After Report properties. or any other <body> HTML attributes). File Is any valid text or graphics file..

background color or images. Values Any filename or a text string containing valid HTML commands. respectively.. use the SRW. you can specify it in a Format Trigger for an object on that page.g.Before Page Value
Description The Before Page Value property specifies a header to appear at the beginning of each page of your document when the report is output to an HTML file and viewed in a Web browser.
n If you want this value to apply only to the current page. if you specified a Before Page Type of File. Applies to reports Required/Optional Required. If you use HTML page streaming.
364
Report Builder Reference
. use the Before Report or After Report properties.
PL/SQL To define this attribute using PL/SQL. this property applies to all pages of your report output (e. Default blank Usage Notes
n
This property is useful for placing a logo or some standard links at the beginning of each page of an HTML document. depending on what you specified for the Before Page Type. To specify HTML for only the first (header) or last (footer) pages of your report. or any other <body> HTML attributes).SET BEFORE PAGE HTML procedure.

use the Before Report or After Report properties. this property applies to all pages of your report output.SET AFTER PAGE HTML procedure. To specify HTML for only the first (header) or last (footer) pages of your report. Values Text Is any text string containing valid HTML commands. respectively. Default Text PL/SQL To define this attribute using PL/SQL. if you specified an After Page Value.
Report Builder Reference
365
. File Is any valid text or graphics file. use the SRW.After Page Type
Description The After Page Type property specifies the type of footer to appear at the end of each page of your document when the report is output to an HTML file and viewed in a Web browser. If you use HTML page streaming. Applies to reports Required/Optional Required.

To specify HTML for only the first (header) or last (footer) pages of your report. Values Any filename or a text string containing valid HTML commands. this property applies to all pages of your report output. If you use HTML page streaming. PL/SQL To define this attribute using PL/SQL.After Page Value
Description The After Page Value property specifies a footer to appear at the end of each page of your document when the report is output to an HTML file and viewed in a Web browser. if you specified an After Page Type of File. you can specify it in a Format Trigger for an object on that page. use the SRW.SET AFTER PAGE HTML procedure. depending on what you specified for the After Page Type. you must ensure that it contains the equivalent HTML commands.
366
Report Builder Reference
. use the Before Report or After Report properties. Applies to reports Required/Optional Required.
n If you want this value to apply only to the current page. Default The default HTML commands included at the end of a page: <hr size=5 noshade> Usage Notes
n
This property is useful for placing a logo or some standard links at the end of each page of an HTML document.
After Page Value restrictions
n
If you replace the default text. respectively.

Default Text PL/SQL To define this attribute using PL/SQL.
Report Builder Reference
367
. use the SRW. Values Text Is any text string containing valid HTML commands.SET BEFORE FORM HTML procedure. if you specified a Before Form Value. File Is any valid text or graphics file Applies to reports Required/Optional Required.Before Form Type
Description The Before Form Type property specifies the type of header to appear at the beginning of your runtime parameter form when the report is output to an HTML file and viewed in a Web browser.

Values Any valid filename or a text string containing valid HTML commands. if you specified a Before Form Type of File. use the SRW. depending on what you specified for Before Form Type. Applies to reports Required/Optional Required.
Before Form Value restrictions
n
If you replace the default text.SET BEFORE FORM HTML procedure. Default The default HTML commands included at the beginning of a Runtime Parameter Form: <html> <body bgcolor="#ffffff"> <form method=post> <center> <p><hr> <table border=0 cellspacing=0 cellpadding=0> <tr> <td><input type=submit> <td width=15> <td><input type=reset>> </table> <p><hr><p> Usage Notes
n
This property is useful for placing a logo or some standard links at the beginning of a runtime parameter form for an HTML document.
PL/SQL To define this attribute using PL/SQL. you must ensure that it contains the equivalent HTML commands.Before Form Value
Description The Before Form Value property specifies a header to appear at the beginning of your runtime parameter form when the report is output to an HTML file and viewed in a Web browser.
368
Report Builder Reference
.

SET_AFTER_FORM_HTML procedure. use the SRW. if you specified an After Form Value. Values Text Is any text string containing valid HTML commands.After Form Type
Description The After Form Type property specifies the type of footer to appear at the end of your runtime parameter form when the report is output to an HTML file and viewed in a Web browser. File Is any valid text or graphics file Applies to reports Required/Optional Required.
Report Builder Reference
369
. Default Text PL/SQL To define this attribute using PL/SQL.

After Form Value
Description The After Form Value property specifies a footer to appear at the end of your runtime parameter form when the report is output to an HTML file and viewed in a Web browser. Default The default HTML commands included at the end of a runtime parameter form: </center> </body> </form> </html> Usage Notes
n
This property is useful for placing a logo or some standard links at the end of a Runtime Parameter Form for an HTML document. Values Any valid filename or a text string containing valid HTML commands. you must ensure that it contains the equivalent HTML commands. use the SRW. if you specified an After Form Type of File.
PL/SQL To define this attribute using PL/SQL.SET_AFTER_FORM_HTML procedure.
370
Report Builder Reference
. Applies to reports Required/Optional Required. depending on what you specified for After Form Type.
After Form Value restrictions
n
If you replace the default text.

Design in Character Units
Description The Design in Character Units property specifies that the Report Editor and its grid use units of character cells. Using this and Include Borders causes the Report Editor to display character-mode borders for objects with line widths greater than zero. Default No
Report Builder Reference
371
.

select Yes.
372
Report Builder Reference
. Applies to reports Default No Usage Notes
n
You can restore the default hint line by deleting the hint text you entered in the Previewer Hint Line Text property and setting the Use Previewer Hint Line property to No. To change the default hint line. and type the desired text in the Previewer Hint Line Text property. Values If Yes.Use Previewer Hint Line
Description The Previewer Hint Line is the line of the Live Previewer view that is displayed on the second to last line of your screen. enter the text in the Previewer Hint Line Text property.

Previewer Hint Line Text
Description The Previewer Hint Line is the line of the Live Previewer view that is displayed on the second to last line of your screen. Values Enter an alphanumeric string not to exceed 80 bytes. Applies to reports

Report Builder Reference

373

Use Previewer Status Line
Description The Previewer Status Line is the last line of the Live Previewer view. To change the default status line, select Yes, and type the desired text in the Previewer Status Line Text property. Values If Yes, enter the text in the Previewer Status Line Text property. Applies to reports Default No Usage Notes

n

You can restore the default status line by deleting the status text you entered in the Previewer Status Line Text property and setting the Use Previewer Status Line property to No.

Use Previewer Status Line restrictions
n n
If Previewer Status Line is set to No, Report Builder does not reserve a line for it. This enables you to see one more line of your report output per screen. When you change the Previewer Status Line Text, the report name will not appear in the status line unless you enter it there yourself. For example, you could enter: This report is for Human Resources personnel only (Report: deptinfo)

374

Report Builder Reference

Previewer Status Line Text
Description The Previewer Status Line is the last line of the Live Previewer view. Values Enter an alphanumeric string not to exceed 80 bytes. Applies to reports

Report Builder Reference

375

Include Bitmapped Objects
Description The Include Bitmapped Objects property converts all bit-mapped objects (i.e., Graphics Builder displays and boilerplate objects except for text, lines, and rectangles) to boxes when the report is run in character mode. If set to No, all bit-mapped objects and any explicit anchors to them will be deleted when the report is run in character mode. Applies to reports Default No

Include Bitmapped Objects restrictions
n
Lines that are not horizontal or vertical will always be converted to horizontal or vertical lines in character mode, regardless of this setting. Similarly, rotated rectangles will be converted to non-rotated rectangles in character mode, regardless of this setting.

376

Report Builder Reference

Include Borders
Description The Include Borders Property turns on borders in character mode for any objects that have a line width greater than zero in bit-mapped. If set to No, all borders are turned off in character mode. Applies to reports Default No Usage Notes

n

Setting both this property and the Design in Character property to Yes causes the Report Editor to display character-mode borders for objects with line widths greater than zero.

Report Builder Reference

377

Disable Host Menu Item
Description The Disable Host Menu Item property disables the Host item in the File menu in both Runtime Parameter Form and Live Previewer views. The Host item appears in the File menu of character-mode Report Builder. Applies to reports Default No

Disable Zoom Key restrictions
n
If Disable Zoom Key and Start in Zoom are both set to Yes, the Live Previewer view will be displayed with Zoom toggled on, and you will be unable to toggle out of Zoom.

380

Report Builder Reference

Start in Zoom
Description The Start in Zoom property displays the Live Previewer view with Zoom toggled on, (i.e., the border that normally appears around the Live Previewer view is not visible and all you see is the report output). Applies to reports Default No

Start in Zoom restrictions
n
(If Disable Zoom Key and Start in Zoom are both set to Yes, the Live Previewer view will be displayed with Zoom toggled on, and you will be unable to toggle out of Zoom.

Report Builder Reference

381

Suppress Previewer Title
Description The Suppress Previewer Title property suppresses the display of the Title in the character mode Previewer. Applies to reports Default Yes

PL/SQL Statement
Description The PL/SQL Statement property is a button that displays the PL/SQL Editor in which you can enter a PL/SQL function that uses a ref cursor to return data. Applies to queries Required/Optional Required

Distribution
Description The Distribution property uses the values specified in the Distribution dialog box to define a distribution for the current section. Applies to sections Required/Optional optional
386
Report Builder Reference
.

n
n n
You can override the dimensions of a page by specifying different values for the PAGESIZE parameter on the command line. The maximum height depends upon the Unit of Measurement. Applies to sections Required/Optional required Default 11 inches
Height restrictions
n n
The page must be large enough to contain the section. For inches.g. you can either increase the printable area for the printer (if your operating system allows it) or you can set the Width and Height to be the size of the printable area of the page. so that the dimensions of the margin are preserved wherever possible. To avoid clipping. the maximum height is 512 inches. it is 36. if a frame in a section expands to a size larger than the Height. For centimeters. it is 1. Values Enter a valid height of zero or more.Height
Description The Height property is the height of one physical page (including the margin) in the Unit of Measurement (e.. If you change the Width or Height of the physical page. the Height will automatically change to the approximate height in the new Unit of Measurement.5 inches. clipping may occur in your report output.312 centimeters. For points. the sheet of paper a printer takes may be 8. If you define a Width and Height that is bigger than the printable area your printer allows. Caution: On some printers the printable area of the physical page is restricted. 11 inches). but the printer might only be able to print on an area of 8 x 10. the size of the logical page will change accordingly.864 points.5 x 11 inches.
Report Builder Reference
387
. For example. The default top and bottom margin is half an inch each. For example. If you change the Unit of Measurement after you have already specified the Height. the report will not run.

Horizontal Panels per Page size is 3 and Vertical Panels per Page size is 2. See the online help for details and illustrations. a Horizontal Panels per Page size of 1 means that each logical page is one physical page wide. one logical page is made up of six physical pages. you would specify a Horizontal Panels per Page size of 2 and a Vertical Panels per Page size of 3. Applies to sections Required/Optional required Default 1
Horizontal/Vertical Panels per Page example
Panels are the representations of the physical pages within a logical page. Values Any whole number from 1 through 50. If you wanted the logical page to be two physical pages wide and three physical pages high. In this example.
388
Report Builder Reference
. For instance. The logical page is three physical pages wide and two physical pages high. Consequently.Horizontal Panels per Page
Description The Horizontal Panels per Page property is the width of the logical page (report page) in physical pages (printer pages).

999 Applies to sections Required/Optional required Default 80 characters
Report Height restrictions
n
When displaying a character-mode report in the bit-mapped Live Previewer view.Report Height
Description The Report Height property is the height of your report page in character units.
390
Report Builder Reference
. Values Any whole number from 1 through 9. As a result. The font may be slightly larger or smaller than the actual character cell size. you may see some truncation. Report Builder uses this setting to choose the font to display.

you may see some truncation. As a result.999 Applies to sections Required/Optional required Default 66 characters
Report Width restrictions
n
When displaying a character mode report in the bit-mapped Live Previewer view.Report Width
Description The Report Width property is the width of your report page in character units. Values Any whole number from 1 through 9. The font may be slightly larger or smaller than the actual character cell size.
Report Builder Reference
391
. Report Builder uses this setting to choose the font to display.

Applies to sections Required/Optional required Default 1
392
Report Builder Reference
.Vertical Panels per Page
Description The Vertical Panels per Page property is the height of the logical page (report page) in physical pages (printer pages). For instance. Values Any whole number from 1 through 50. a Vertical Panels per Page size of 1 means that each logical page is one physical page in height.

it is 1. clipping may occur in your report output. If you change the Unit of Measurement after you have already specified the Width. For points.
n
n n
You can override the dimensions of a page by specifying different values for the PAGESIZE parameter on the command line. For example.
Report Builder Reference
393
. the Width will automatically change to the approximate width in the new Unit of Measurement.864 points.. For inches.5 inches.Width
Description The Width property is the width of one physical page (including the margin) in the Unit of Measurement (e. so that the dimensions of the margin are preserved wherever possible. the sheet of paper a printer takes may be 8. The default right and left margin size is zero. the report will not run. If you define a Width and Height that is bigger than the printable area your printer allows.312 centimeters. Applies to sections Required/Optional required Default 8. For centimeters. but the printer might only be able to print on an area of 8 x 10. To avoid clipping. it is 36. If you change the Width or Height of the physical page.5 inches
Width restrictions
n
n
The page must be large enough to contain the section. you can either increase the printable area for the printer (if your operating system allows it) or you can set the Width and Height to be the size of the printable area of the page. the maximum width is 512 inches. The maximum width depends upon the Unit of Measurement. For example.5 inches). the size of the logical page will change accordingly. if a frame in a section expands to a size larger than the Width. 8.g.5 x 11 inches. Values Enter a valid width of zero or more. Caution: On some printers the printable area of the physical page is restricted.

for summary columns with a Function of % of Total. Report Is used to calculate the source column as a percentage of the total values in the report.00 27. contains the ENAME and SAL columns.61% JONES 2975.86% 6.11% 5. Default The parent group of the summary column’s group
Compute At example (group report)
Suppose that you have a report that looks like the one below: Deptno 10 Dname ACCOUNTING Ename Sal %Dept %Total ----------. <names> Is used to calculate the source column as a percentage of the total values in the group(s). SMITH’s salary/total department salaries).48% KING 5000.16% SCOTT 3000.08% ADAMS 1100.36% 15. Applies to summary columns Required/Optional required.00 27..Compute At
Description The Compute At property is the group over which a % of Total summary column is computed. The child group.29% FORD 3000. Compute At defines the total for a percentage calculation. contains the DEPTNO and DNAME columns.59% 15.00 57.29% The parent group. you create a summary column in G_EMP with the following settings: Function Reset At Compute At
Report Builder Reference
395
.00 27. Report Builder determines the total of which each source column value is a percentage.00 14. G_DEPT.00 28.62% CLARK 2450. Values Page Is used to calculate the source column as a percentage of the total values on a page. G_EMP. To get a summary that calculates each employee’s salary as a percentage of total department salaries (Pct_Dept).-------------------MILLER 1300. Using this field. Compute At can be multiple groups.00 7.00% 12.14% 25.g. you divide a value by a total (e. Compute At is used only for columns with a Function of % of Total.00 10. For matrix reports.48% Deptno 20 Dname RESEARCH Ename Sal %Dept %Total ----------.36% 4.-------------------SMITH 800.59% 15. When you calculate a percentage.

Compute At indicates that the total of salaries for the department is the whole (100%) across which to compute the percentages. Compute At indicates that the total of salaries for the job category is the whole (100%) across which to compute the percentages. Reset At indicates that the summary should be reset to null for each employee and the summary is placed in the G_EMP group because you want the percentage to appear for each employee. To get a summary that calculates each employee’s salary as a percentage of total salaries for the entire report (Pct_Total). Reset At indicates that the summary should be reset to null for each department. and G_CROSS is the cross-product group. It should also be noted that this summary is placed in the G_EMP group because you want the percentage to appear for each employee. This is because you want a separate percentage for each individual employee. As with the Pct_Dept summary above. G_DEPT contains DEPTNO. G_SAL contains SUMSAL. (G_CROSS contains all of the summaries for the matrix.
Compute At example (matrix report)
Suppose that you have a matrix report that looks something like the one below and you want to add some percentage summaries to it. It should also be noted that this summary is placed in G_CROSS because all summaries that apply to the matrix itself must belong to the cross-product group.
396
Report Builder Reference
. Compute At indicates that the total of salaries for the entire report is the whole (100%) across which to compute the percentages. you create a summary column in G_EMP with the following settings: Function Reset At Compute At % of Total G_EMP Report In this case.G_DEPT % of Total G_EMP In this case.) To get a summary that calculates each job category’s total salaries per department as a percentage of total salaries for that job in all departments. Reset At indicates that the summary should be reset to null for each employee. % of G_DEPT Total In this case. This is because you want a separate percentage for each individual department. you would enter the following settings for a summary column in G_CROSS: Function Reset At Compute At Product Order G_DEPT G_JOB G_JOB. Dept Analyst Clerk Manager Total 10 1300 2450 3750 20 6000 1900 2975 10875 30 950 2850 3800 Total 6000 4150 8275 18425 Group G_JOB contains the column JOB.

) See the online help for details and illustrations. you need to use Product Order for the summary.
Report Builder Reference
397
. then the sizing of the field or boilerplate object that displays it must be fixed. For further information about Product Order. n If a summary has a Compute At of Page. see "Product Order". n Summary columns that are owned by a cross-product group cannot have a Compute At of Page. (One of the examples uses the same output as this example and more fully explains the use of Product Order. n The Compute At group of a summary column may be any group above the summary column’s group. including Report and Page. if the summary column’s group is not Report.
Compute At restrictions
n Compute At is only editable when the column is a summary and the Function is % of Total.Note: Because this is a matrix report.

you place the column in the appropriate group and use Function in conjunction with Reset At. Values Average Calculates the average of the column’s values within the reset group. Maximum Calculates the column’s highest value within the reset group. Deviation. Applies to summary columns Required/Optional required. the datatype of the summary changes to match. n A report-level summary cannot have a Function of % of Total. n Sum. Variance Sums the squares of each column value’s distance from the mean value of the reset group and divides the total by the number of values minus 1. Deviation Calculates the column’s positive square root of the variance for the reset group. and Variance can only be applied to fields with a Datatype of Number. Minimum Calculates the column’s lowest value within the reset group. Count Counts the number of records within the reset group. Std. Sum Calculates the total of the column’s values within the reset group. n If the column being summarized is changed. To create running summaries. First Prints the column’s first value fetched for the reset group. Average. % of Total. if column is a summary column. % of Total Calculates the column’s percent of the total within the reset group. n Report Builder sets the Datatype for the summary based on the Datatype of the column being summarized. Default blank
Function restrictions
n Function is only editable when the Type of the column is Summary.Function
Description The Function property is the computation to be performed on the values of the column specified in Source. Last Prints the column’s last value fetched for the reset group. Such a column
398
Report Builder Reference
. Std.

n The Average function will ignore null values in a column (i. or Variance cannot be a break column and cannot have Break Order set. it does not assume a null value equals zero)..
Report Builder Reference
399
.e. Sum.
n A column with a Function of % of Total.would make no sense because it would always be 100%.

if the column is a summary or formula column belonging to a cross product group. you must use Product Order to specify for Report Builder which group should be evaluated first. each year) so Product Order is G_YEAR. the summary.) To get the summary of salaries by job.Product Order
Description The Product Order property is the order in which groups are evaluated in the cross product for a summary. G_SAL contains SUMSAL. G_YEAR contains YEAR. which second.) To get the summary of salaries by year.. you want the summary to calculate a sum for each record of G_YEAR (i. Applies to summary. and so on. you create a summary column in G_CROSS with the following settings: Function Reset At Product Order G_DEPT G_YEAR.. when creating a summary for a cross product. Product Order is used only for columns owned by cross-product groups. G_DEPT contains DEPTNO. or placeholder has one value for each combination of values of the groups in its Product Order. (This summary appears along the bottom of the matrix. you create a summary column in G_CROSS with the following settings: Function Reset At Product Order G_YEAR G_YEAR Sum In this case.e. G_DEPT Sum
400
Report Builder Reference
. Because a cross product relates multiple groups. Therefore. Values A valid group combination.) To get the summary of salaries for each department in each year. You must also use Product Order to specify the frequency of a summary. formula. you want the summary to calculate a sum for each record of G_JOB (i. or placeholder in a cross product group.
Product Order example (single group)
Suppose that you have a matrix report. or placeholder within the cross product. Product Order also defines the frequency of a summary. (This summary appears along the right edge of the matrix directly underneath a boilerplate line. you create a summary column in G_CROSS with the following settings: Function Reset At Product Order G_JOB G_JOB % of Total In this case. formula.e. each job category) so Product Order is G_JOB. the groups in the cross product could be evaluated in any one of many different orders. (G_CROSS contains all of the summaries for the matrix. formula. Group G_JOB contains the column JOB. That is. See the online help for details and illustrations. and G_CROSS is the cross product group. formula. and placeholder columns Required/Optional required.

G_SAL contains SUMSAL. See the online help for details and illustrations. G_DEPT % of Total In this case. To get a summary that calculates each department’s total salaries per job category as a percentage of total salaries in the report.. G_DEPT has the lowest frequency (it changes only once per three jobs) and is the first group in Product Order. See the online help for details and illustrations.. you would enter the following settings for a summary column in G_CROSS: Function Reset At Compute At Product Order G_DEPT G_JOB G_JOB. you would enter the following settings for a summary column in G_CROSS:
Report Builder Reference
401
. Dept Analyst Clerk Manager Total 10 1300 2450 3750 20 6000 1900 2975 10875 30 950 2850 3800 Total 6000 4150 8275 18425 Group G_JOB contains the column JOB. and G_CROSS is the cross product group. you would enter the following settings for a summary column in G_CROSS: Function Reset At Compute At Product Order G_JOB G_DEPT G_DEPT. Since the summary goes across the matrix after going down. To get a summary column that calculates each job category’s total salaries per department as a percentage of total salaries for that job in all departments. Since the summary goes down the matrix only after going across. it changes three times for each record of G_YEAR). To get a summary that calculates each department’s total salaries per job category as a percentage of total salaries for that department. As a result. G_DEPT has the highest frequency (it changes three times per one job) and is the second group in the Product Order. you want the summary to go across the matrix and then down. Since the summary goes down the matrix first. For this summary. you want the summary to calculate a sum for each department in each year (G_DEPT and G_YEAR). G_JOB has the lowest frequency (it changes only once per three departments) and is the first group in Product Order. Since the summary goes across the matrix first. G_YEAR (lowest frequency) appears first and G_DEPT (highest frequency) appears second in Product Order. G_JOB % of Total In this case.e. G_YEAR has the lowest frequency (i.e. G_JOB has the highest frequency (it changes three times per one department) and is the second group in the Product Order. it changes only once for each three records of G_DEPT) and G_DEPT has the highest frequency (i.
Product Order example (multiple group)
Suppose that you have a matrix report that looks something like the one below and you want to add some percentage summaries to it. G_DEPT contains DEPTNO.In this case. you want the summary to go down the matrix and then across.

G_DEPT contains DEPTNO. Product Order could be either G_DEPT. DEPTSUM. The source column of the summary must be at least as frequent as the summary. Dept Analyst Clerk Manager President Salesman 10 1300 2450 5000 20 6000 1900 2975 30 950 2850 5600 Group G_JOB contains the column JOB. or down the matrix and then across because you are computing this summary for the entire report (e. the frequency of the formula is the same as the summary column. you must give it a Product Order.
Product Order example (formula)
Suppose that you have a matrix report that looks something like the one below and you want to add a formula to it. G_JOB (across. G_DEPT. In this case. Note. across). and G_CROSS is the cross product group. that Reset At must be the group that has the highest frequency: G_DEPT if Product Order is G_JOB. G_JOB if Product Order is G_DEPT..9 Because the formula is in G_CROSS.e. formula. This would calculate the formula as follows: Dept Analyst Clerk Manager President Salesman Comp 10 1300 2450 5000 7875 20 6000 1900 2975 9788 30 950 2850 5600 8460
Product Order restrictions
n This field is only available if the summary. Compute At is Report). its Reset At is not Report) must have a Product Order that is a subset of its source column’s Product Order. or placeholder column’s group is a cross product. however. the summary could go across the matrix and then down.g. G_JOB. G_JOB % of Total Report In this case. n A summary which is not a running summary (i. See the online help for details and illustrations.. down) or G_JOB. you first create a summary column (DEPTSUM) in G_CROSS with the following settings: Function Reset At Product Order G_DEPT G_DEPT % of Total Next. G_DEPT (down. which means that the summary’s Product Order should be some subset of the source
402
Report Builder Reference
. G_SAL contains SUMSAL.Function Reset At Compute At Product Order G_JOB G_DEPT. To add a formula that calculates the sum of after-tax salaries for each department. you create a formula (AFTERTAX) in G_CROSS with the following settings: Formula Product Order :deptsum * G_DEPT .

then the summary column’s Product Order would have to be either A (by itself) or A.
n A running summary (i.column’s Product Order.B. if the source column’s Product Order were A. For example. The summary’s Product Order could not be B.B.A.
Report Builder Reference
403
. its Reset At is Report) must have a Product Order that is a prefix of the source column’s Product Order..C.e.

make sure each record fits on a single page.Reset At
Description The Reset At property is the group at which the summary column value resets to zero (if Function is Count).-----10 SMITH 1000 1000 1000 JONES 1000 2000 2000 KING 1000 3000 3000 20 JOHNSON 1500 1500 4500 WARD 1000 2500 5500 The parent group. The summary is reset after each record of the group.. such as grand totals. The summary is reset between pages. The child group. Usage Notes
n n
The reset group of a summary column may be its group or any group above its group.------. you create a summary column in G_EMP with the following settings Function Reset At G_DEPT Sum
404
Report Builder Reference
. force each new record to print on a new page. group-level) summary.-------. G_EMP. To get the sum of salaries for each department (RESETSUM). including Report and Page. The summary is reset after the report (i. G_DEPT. for columns of Type Summary. To ensure that page summaries behave in a predictable way. or Value If Null (if the column has one).---. Values Page Is used for page-level summaries.
Reset At example (group)
Suppose that you want to create a group report like the one below: DEPT NAME SAL RESETSUM RUNSUM ---. Reset At has a list of values containing valid reset groups. Applies to summary columns Required/Optional required. or if that is not feasible. contains ENAME and SAL.e. contains the DEPTNO column. it is never reset). Reset At determines if the summary is a running summary or a periodic (e. Report Is used for summaries that apply to the entire report.. null (if Function is not Count).g. <names> Is a valid group name.

n If a column has a Reset At of Page. Reset At indicates that the summary should not be reset to null but should accumulate throughout the report. n Summary columns that are owned by a cross-product group cannot have a Reset At of Page.. then any fields that use it as a source must be contained in repeating frames that use the column’s group as their source. n A Reset At of Page will not work for reports that have multiple repeating frames associated with a group that is involved in the summary. then the sizing of the field or boilerplate object that displays it must be fixed. summary columns with a Reset At of Page may give unexpected results.g. you create a summary column in G_EMP with the following settings: Function Reset At Sum Report In this case. One common case of this is a matrix report. Reset At indicates that the summary should be set to null after each department. a Reset At of Page may produce incorrect results.
Report Builder Reference
405
.In this case.
Reset At restrictions
n Reset At is only editable for summary columns. As a result. n For multiple summary columns that are in child groups that share the same parent group. n If your data model contains multiple child groups with a shared parent (e. matrix reports cannot have page-level summaries. To get the running sum of salaries (RUNSUM). masterdetail-detail). n If a summary has a Reset At of Page.

n Any column can be the Source of multiple summary columns. Default blank
Source restrictions
n The source of a summary column may be any column within or below the summary column’s group (with a valid Datatype for the function).
406
Report Builder Reference
. n If you change the Source of a summary column. n If you specify a source for a summary column and later delete the source column from your report. the Datatype of the summary column changes to reflect the Datatype of the new source column. your summary column no longer has access to data to summarize. unless the column has Read from File specified.Source
Description The Source property is the name of the column whose values will be summarized. Values Any valid column name. if the column is a summary column. Applies to summary columns Required/Optional required.

Alignment
Description The Alignment property defines how labels and fields on a line are positioned across the page. Right Means the right-most label or field is aligned with the right side of the page. See the online help for details and illustrations. Column Means labels and fields are aligned in columns spaced evenly across the page. See the online help for details and illustrations. See the online help for details and illustrations. See the online help for details and illustrations. Flush Means the labels and fields are spaced evenly across the page. Applies to templates Default Left
408
Report Builder Reference
. with the left-most label or field aligned with the left side of the page and the right-most label or field aligned with the right side of the page. The number of fields and columns per line is determined by the Fields Per Line property. Values Left Means the left-most label or field is aligned with the left side of the page. Center Means the labels and fields are centered across the page. based on the widths of the largest label and largest field. See the online help for details and illustrations. This property applies only if the Style is Form.

if set to Yes. This property applies only if the Style is Form. Applies to templates Default Yes
Report Builder Reference
409
. See the online help for details and illustrations.Align Summaries with Fields
Description The Align Summaries with Fields property places summary fields under their source fields.

If the Fill Pattern property is set to solid.Background Color
Description The Background Color property defines the background color of the Fill Pattern property setting. then both the Background Color and Foreground Color settings are ignored.SET BACKGROUND FILL COLOR procedure.
PL/SQL To define this attribute using PL/SQL. and only the Foreground Color setting is visible.
410
Report Builder Reference
. Applies to templates Default white Usage Notes
n n
If the Fill Pattern property is set to transparent. then the Background Color setting is ignored. use the SRW. Values Choose a valid color from the color palette.

However. This property applies only if the Style is Form. or points). you can turn off Grid Snap when you create the report. this means that objects will no longer snap to the grid snap points. objects will snap to the nearest grid snap points. Values Enter a value of zero or more. The value will be in the Unit of Measurement for the report (inches. in which labels are to the left of fields. If you want a greater level of spacing control.
n
Report Builder Reference
411
. you’ll need to change this setting accordingly. If you change the Unit of Measurement for the report. Thus. Applies to templates Default 0 Usage Notes
n
If Grid Snap is on. there is no vertical space counterpart to this property. centimeters. regardless of this setting.Between Field and Labels (Horizontal)
Description The Between Field and Labels (Horizontal) property defines the amount of horizontal space between fields and their associated labels in a group.

this means that objects will no longer snap to the grid snap points.Between Frame and Fields (Horizontal)
Description The Between Frame and Fields (Horizontal) property defines the amount of horizontal space between frames and the fields they enclose. If you change the Unit of Measurement for the report.
n
412
Report Builder Reference
. The value will be in the Unit of Measurement for the report (inches. you can turn off Grid Snap when you create the report. However. centimeters. you’ll need to change this setting accordingly. If you want a greater level of spacing control. or points). Values Enter a value of zero or more. objects will snap to the nearest grid snap points. regardless of this setting. Applies to templates Default 0 Usage Notes
n
If Grid Snap is on.

The value will be in the Unit of Measurement for the report (inches.
n
Report Builder Reference
413
. objects will snap to the nearest grid snap points. However. Applies to templates Default 0 Usage Notes
n
If Grid Snap is on.Between Frame and Fields (Vertical)
Description The Between Frame and Fields (Vertical) property defines the amount of vertical space between frames and the fields they enclose. If you change the Unit of Measurement for the report. or points). you can turn off Grid Snap when you create the report. If you want a greater level of spacing control. regardless of this setting. you’ll need to change this setting accordingly. this means that objects will no longer snap to the grid snap points. Values Enter a value of zero or more. centimeters.

regardless of this setting. or points). If you change the Unit of Measurement for the report. However. you’ll need to change this setting accordingly. If you want a greater level of spacing control. you can turn off Grid Snap when you create the report. objects will snap to the nearest grid snap points. Applies to templates Default 0 Usage Notes
n
If Grid Snap is on.
n
414
Report Builder Reference
. The value will be in the Unit of Measurement for the report (inches. this means that objects will no longer snap to the grid snap points.Between Master and Detail (Horizontal)
Description The Between Master and Detail (Horizontal) property defines the amount of horizontal space between the master group frame and the detail group frame. Values Enter a value of zero or more. centimeters.

Applies to templates Default 0 Usage Notes
n
If Grid Snap is on. If you want a greater level of spacing control.
n
Report Builder Reference
415
. centimeters. If you change the Unit of Measurement for the report. or points). regardless of this setting.Between Master and Detail (Vertical)
Description The Between Master and Detail (Vertical) property defines the amount of vertical space between the master group frame and the detail group frame. Values Enter a value of zero or more. objects will snap to the nearest grid snap points. The value will be in the Unit of Measurement for the report (inches. this means that objects will no longer snap to the grid snap points. However. you can turn off Grid Snap when you create the report. you’ll need to change this setting accordingly.

The value will be in the Unit of Measurement for the report (inches. centimeters. this means that objects will no longer snap to the grid snap points. or points). However. regardless of this setting. Values Enter a value of zero or more. you’ll need to change this setting accordingly. If you want a greater level of spacing control. objects will snap to the nearest grid snap points. If you change the Unit of Measurement for the report.
n
416
Report Builder Reference
. you can turn off Grid Snap when you create the report. Applies to templates Default 0 Usage Notes
n
If Grid Snap is on.Between Page and Frames (Horizontal)
Description The Between Page and Frames (Horizontal) property defines the amount of horizontal space between the edge of the page and the highest-level group frame.

regardless of this setting. objects will snap to the nearest grid snap points. centimeters. Values Enter a value of zero or more. However. The value will be in the Unit of Measurement for the report (inches.Between Page and Frames (Vertical)
Description The Between Page and Frames (Vertical) property defines the amount of vertical space between the edge of the page and the highest-level group frame. Applies to templates Default Usage Notes
n
If Grid Snap is on.
n
Report Builder Reference
417
. If you change the Unit of Measurement for the report. If you want a greater level of spacing control. this means that objects will no longer snap to the grid snap points. or points). you can turn off Grid Snap when you create the report. you’ll need to change this setting accordingly.

n
418
Report Builder Reference
. objects will snap to the nearest grid snap points. The value will be in the Unit of Measurement for the report (inches.Between Sibling Frames (Horizontal)
Description The Between Sibling Frames (Horizontal) property defines the amount of horizontal space between the frames of groups at the same level. However. Values Enter a value of zero or more. regardless of this setting. or points). this means that objects will no longer snap to the grid snap points. If you want a greater level of spacing control. centimeters. you can turn off Grid Snap when you create the report. or they may share the same parent group. If you change the Unit of Measurement for the report. you’ll need to change this setting accordingly. Applies to templates Default 0 Usage Notes
n
If Grid Snap is on. The groups may be separate.

If you change the Unit of Measurement for the report.
n
Report Builder Reference
419
. objects will snap to the nearest grid snap points.Between Sibling Frames (Vertical)
Description The Between Sibling Frames (Vertical) property defines the amount of vertical space between the frames of groups at the same level. this means that objects will no longer snap to the grid snap points. or points). or they may share the same parent group. The groups may be separate. regardless of this setting. centimeters. If you want a greater level of spacing control. The value will be in the Unit of Measurement for the report (inches. Applies to templates Default 0 Usage Notes
n
If Grid Snap is on. you’ll need to change this setting accordingly. However. you can turn off Grid Snap when you create the report. Values Enter a value of zero or more.

Bottom Only Means display bottom borders only. Bottom and Right Means display bottom and right borders only. All but Left Means display all except left borders. Bottom and Left Means display bottom and left borders only. Top Only Means display top borders only. Left and Right Means display left and right borders only. Top and Left Means display top and left borders only. Right Only Means display right borders only. Top and Right Means display top and right borders only. Left Only Means display left borders only.Borders
Description The Borders property defines which borders to display for objects. All but Bottom Means display all except bottom borders. Top and Bottom Means display top and bottom borders only. All but Top Means display all except top borders. None Means display no borders. All but Right Means display all except right borders. Applies to templates Default All
420
Report Builder Reference
. Values All Means display all borders.

Alternatively. Values Left Means the text is aligned left. Alternatively. Start Means the text is aligned left or right depending on where it would normally start for the language. for languages that flow from left to right. Right Means the text is aligned right. Start justifies the text Right. if the datatype of the field’s Source is CHARACTER. Start justifies the text Left. for languages that flow from right to left. For example. Center Means the text is centered. End justifies the text Right. For example. End Means the text is aligned left or right depending on where it would normally end for the language. Applies to templates Default Start PL/SQL To define this attribute using PL/SQL.SET JUSTIFICATION procedure.Character Justification
Description The Character Justification property defines the method to use for aligning the text of the field or label. for languages that flow from right to left. End justifies the text Left. use the SRW.
Report Builder Reference
421
. for languages that flow from left to right.

for languages that flow from right to left. Alternatively. for languages that flow from left to right. End justifies the text Right.
Report Builder Reference
423
. Start Means the text is aligned left or right depending on where it would normally start for the language. Values Enter Applies to templates Default Start PL/SQL To define this attribute using PL/SQL. For example. Alternatively.Date Justification
Description The Date Justification property defines the method to use for aligning the text of the field or label. for languages that flow from right to left. For example. Right Means the text is aligned right.SET JUSTIFICATION procedure. use the SRW. Values Left Means the text is aligned left. End Means the text is aligned left or right depending on where it would normally end for the language. if the datatype of the field’s Source is DATE. End justifies the text Left. for languages that flow from left to right. Start justifies the text Left. Center Means the text is centered. Start justifies the text Right.

Values Choose a valid color from the color palette. then both the Edge Foreground Color and Edge Background Color settings are ignored. then only the Edge Foreground Color setting is visible (the Edge Background Color setting is ignored). Applies to templates Default black Usage Notes
n n
If the Edge Pattern property is set to transparent. use the SRW.SET FOREGROUND BORDER COLOR procedure.
PL/SQL To define this attribute using PL/SQL.
424
Report Builder Reference
.Edge Foreground Color
Description The Edge Foreground Color defines the foreground color of the Edge Pattern property setting. If the Edge Pattern property is set to solid.

If the Edge Pattern property is set to solid.Edge Background Color
Description The Edge Background Color property defines the background color of the Edge Pattern property setting. then both the Edge Background Color and Edge Foreground Color settings are ignored. Applies to templates Default white Usage Notes
n n
If the Edge Pattern property is set to transparent.
PL/SQL To define this attribute using PL/SQL. and only the Edge Foreground Color setting is visible. Values Choose a valid color from the color palette.SET BACKGROUND BORDER COLOR procedure. then the Edge Background Color setting is ignored. use the SRW.
Report Builder Reference
425
.

then only the Edge Foreground Color property setting is visible.
426
Report Builder Reference
. Applies to templates Default transparent Usage Notes
n n
If you set the Edge Pattern to transparent. If you set the Edge Pattern to solid.SET BORDER PATTERN procedure.
PL/SQL To define this attribute using PL/SQL. Values Choose a valid pattern from the pattern palette.Edge Pattern
Description The Edge Pattern property defines the pattern to use for the borders of the objects. use the SRW. the Edge Foreground Color and Edge Background Color property settings are ignored. You can define the background and foreground colors of the edge pattern using the Edge Foreground Color and Edge Background Color properties.

Fields Per Line
Description The Fields Per Line property defines the maximum number of field/label combinations that may appear on a line. space permitting. and the value is set to three. then only two field/label combinations will appear. Zero means that there is no maximum value. However. This property applies only if the Style is Form. Applies to templates Default 0
Report Builder Reference
427
. Values Enter a value of zero or more. For example. if there is space for four field/label combinations and the value is set to three. and as many field/label combinations as will fit on a line will appear. then only three will appear since three is the maximum allowed. if there is only space for two field/label combinations.

Applies to templates Default transparent Usage Notes
n n
If you set the Fill Pattern to transparent.
PL/SQL To define this attribute using PL/SQL. then only the Foreground Color property setting is visible.SET FILL PATTERN procedure. the Foreground Color and Background Color property settings are ignored.
428
Report Builder Reference
. Values Choose a valid pattern from the pattern palette. You can define the background and foreground colors of the fill pattern using the Foreground Color and Background Color properties. If you set the Fill Pattern to solid.Fill Pattern
Description The Fill Pattern property defines the pattern to use for the space enclosed by the objects. use the SRW.

Regular PL/SQL To define the font face using PL/SQL.SET FONT FACE procedure.SET FONT SIZE procedure. To define the font size using PL/SQL. Values Choose a valid font from the list of fonts for your system. use the SRW. use the SRW. use the SRW..Font
Description The Font property defines the text font to use for the object(s). To define the font style using PL/SQL.
Report Builder Reference
429
. Applies to templates Default Courier. 10 pt.SET FONT STYLE procedure.

Foreground Color
Description The Foreground Color defines the foreground color of the Fill Pattern property setting. then both the Foreground Color and Background Color settings are ignored.
PL/SQL To define this attribute using PL/SQL. Applies to templates Default black Usage Notes
n n
If the Fill Pattern property is set to transparent.SET FOREGROUND FILL COLOR procedure. If the Fill Pattern property is set to solid. then only the Foreground Color setting is visible (the Background Color setting is ignored). Values Choose a valid color from the color palette.
430
Report Builder Reference
. use the SRW.

Values Enter the name of a valid text file. Applies to templates Default none
Report Builder Reference
431
.Image
Description The Image property is the substitution file to use for images referenced in link file (external) boilerplate objects in your templates.

n
432
Report Builder Reference
. regardless of this setting. If the Style is Form. Applies to templates Default . The distance between the field and label is determined by the Between Field and Labels (Horizontal) property setting. If you change the Unit of Measurement for the report. centimeters. you’ll need to change this setting accordingly. If you want a greater level of spacing control. Values Enter a value of zero or more. The value will be in the Unit of Measurement for the report (inches. objects will snap to the nearest grid snap points. this means that objects will no longer snap to the grid snap points. this property defines the amount of horizontal space between the end of one field/label combination and the beginning of another field/label combination in a group. or points).Inter-Field (Horizontal)
Description The Inter-Field (Horizontal) property defines the amount of horizontal space between fields in a group. However.174 inches Usage Notes
n
If Grid Snap is on. you can turn off Grid Snap when you create the report.

or points). The value will be in the Unit of Measurement for the report (inches. regardless of this setting.
n
Report Builder Reference
433
. If you change the Unit of Measurement for the report. objects will snap to the nearest grid snap points. you’ll need to change this setting accordingly. this means that objects will no longer snap to the grid snap points. If you want a greater level of spacing control. However. Applies to templates Default 0 Usage Notes
n
If Grid Snap is on.Inter-Field (Vertical)
Description The Inter-Field (Vertical) property defines the amount of vertical space between fields in a group. you can turn off Grid Snap when you create the report. Values Enter a value of zero or more. centimeters.

or points). this means that objects will no longer snap to the grid snap points. If you want a greater level of spacing control. Applies to templates Default . If you change the Unit of Measurement for the report. However.Inter-Frame (Horizontal)
Description The Inter-Frame (Horizontal) property defines the amount of horizontal space between frames in a group.
n
434
Report Builder Reference
. you’ll need to change this setting accordingly. Values Enter a value of zero or more. regardless of this setting. centimeters.0087 inches Usage Notes
n
If Grid Snap is on. objects will snap to the nearest grid snap points. you can turn off Grid Snap when you create the report. The value will be in the Unit of Measurement for the report (inches.

Values Enter a value of zero or more. However.0136 inches Usage Notes
n
If Grid Snap is on. or points). The value will be in the Unit of Measurement for the report (inches. this means that objects will no longer snap to the grid snap points. regardless of this setting. centimeters. you can turn off Grid Snap when you create the report. If you want a greater level of spacing control.Inter-Frame (Vertical)
Description The Inter-Frame (Vertical) property defines the amount of vertical space between frames in a group. If you change the Unit of Measurement for the report. Applies to templates Default .
n
Report Builder Reference
435
. you’ll need to change this setting accordingly. objects will snap to the nearest grid snap points.

End Means the text is aligned left or right depending on where it would normally end for the language. for languages that flow from right to left. Values Left Means the text is aligned left. For example. for languages that flow from left to right.Justify
Description The Justify property defines the method to use for aligning the text in the title. Alternatively. For example. for languages that flow from left to right. End justifies the text Right. for languages that flow from right to left. Start justifies the text Left. Flush Means the text is aligned both left and right. Center Means the text is centered. Applies to templates Default Start
436
Report Builder Reference
. Start Means the text is aligned left or right depending on where it would normally start for the language. End justifies the text Left. Right Means the text is aligned right. Start justifies the text Right. Alternatively.

End Means the text is aligned left or right depending on where it would normally end for the language. For example. Start Means the text is aligned left or right depending on where it would normally start for the language. Center Means the text is centered. for languages that flow from left to right. Alternatively.
Report Builder Reference
437
. Applies to templates Default Start PL/SQL To define this attribute using PL/SQL. Start justifies the text Right. For example. if the datatype of the field’s Source is NUMBER. End justifies the text Right. use the SRW. for languages that flow from right to left. Alternatively. Values Left Means the text is aligned left. Right Means the text is aligned right. Start justifies the text Left. for languages that flow from left to right. End justifies the text Left. for languages that flow from right to left.Number Justification
Description The Number Justification property defines the method to use for aligning the text of the field or label.SET JUSTIFICATION procedure.

This property applies only if the Style is Form. Applies to templates Default No
438
Report Builder Reference
. if set to Yes. rather than to the left of fields.Place Labels Above Fields
Description The Place Labels Above Fields property positions labels above fields.

Report Builder Reference
439
. Applies to templates Default The parent object is displayed above the child object.Position
Description The Position property defines the placement of the parent object in relation to the child object.

See the online help for details and illustrations. Tabular. Applies to templates Default The default Style is determined by the layout style for the template. Mailing Label Not applicable (cannot override). listed below. for groups with a child group. See the online help for details and illustrations. Matrix Tabular (cannot override). and are inside the repeating frame containing the fields. and are outside the repeating frame containing the fields.Style
Description The Style property defines whether the group is given a Tabular or a Form style layout. Values Tabular Means that labels are above fields. as follows: Tabular Tabular Group Left Tabular Group Above Form. for groups with no child group. You can use this property to override the defaults. Matrix Break Tabular (cannot override). Form Means that labels are to the left of fields.
440
Report Builder Reference
. Form-like Form Form Letter Not applicable (cannot override).

Applies to templates Default none
Report Builder Reference
441
. Values Enter the name of a valid text file.Text
Description The Text property is the substitution file to use for boilerplate text objects in templates.

Values Choose a valid color from the color palette. Applies to templates Default black PL/SQL To define this attribute using PL/SQL.
442
Report Builder Reference
.SET COLOR TEXT procedure.Text Color
Description The Text Color property defines the text color to use for the object(s). use the SRW.

if an object on a subsequent line can fit into unused space on a previous line. the object is moved up to occupy the unused space. if set to Yes. For example.Use Vertical Spacing
Description The Use Vertical Spacing property places objects into unused spaces on previous lines. This property applies only if the Style is Form. Applies to templates Default Yes
Report Builder Reference
443
. See the online help for details and illustrations.

loc FROM dept
in a tabular report this will produce the following XML output:
<MODULE1> <LIST_G_DEPTNO> <G_DEPTNO> <DEPTNO>10</DEPTNO> <DNAME>ACCOUNTING</DNAME> <LOC>NEW YORK</LOC> </G_DEPTNO> <G_DEPTNO> <DEPTNO>20</DEPTNO> <DNAME>RESEARCH</DNAME> <LOC>DALLAS</LOC> </G_DEPTNO> <G_DEPTNO> <DEPTNO>30</DEPTNO> <DNAME>SALES</DNAME> <LOC>CHICAGO</LOC> </G_DEPTNO> <G_DEPTNO> <DEPTNO>40</DEPTNO> <DNAME>OPERATIONS</DNAME> <LOC>BOSTON</LOC>
Report Builder Reference
445
. Applies to report. You may choose any name for the element. see the XML Tag example. or column Required/Optional Optional Default Object name (as displayed in the Name property) Usage Notes • • Can contain any characters in a string of any length. group(s). dname. as the XML tag’s purpose is to uniquely identify the object as a particular type or category of data. group or column. The name of the XML element is dependent on the name of the object in the Property Palette.XML Tag
Description The XML Tag property contains the element name of the currently selected report. A query statement such as:
SELECT deptno.
If you do not wish to output XML for this object but do wish to output child tags and data. which permits integration of your report with a third-party application. One reason for generating XML output is to configure objects according to external DTD specifications. group.
XML Tag Example
Suppose you want to create XML output for the report. Changing the Name property will change the XML Tag property to match. and may be user-defined. leave this property blank. and columns of your query. For more information.

See Outer XML Tag Property for more information. The outer XML tag name is selected from the group XML tag name. the XML output would read as follows:
<MODULE1> <LIST_> <DEPTNO>10</DEPTNO> <DNAME>ACCOUNTING</DNAME> <LOC>NEW YORK</LOC> <DEPTNO>20</DEPTNO> <DNAME>RESEARCH</DNAME> <LOC>DALLAS</LOC> <DEPTNO>30</DEPTNO> <DNAME>SALES</DNAME> <LOC>CHICAGO</LOC> <DEPTNO>40</DEPTNO> <DNAME>OPERATIONS</DNAME> <LOC>BOSTON</LOC> </LIST_> </MODULE1>
Note that the tag formerly called <LIST_G_DEPTNO> is now called <LIST_>.
446
Report Builder Reference
. leaving it blank. if you were to delete the G_DEPTNO tag.</G_DEPTNO> </LIST_G_DEPTNO> </MODULE1>
If you wish to suppress various tags from appearing in the output. This will eliminate tag output. If you wish to remove the <LIST_> tag as well. For instance. This is called an Outer XML Tag and is only associated with group tags. but will not exclude any data associated with child tags. simply delete the default name in the XML Tag property field. you may leave the Outer XML Tag field blank.

you would leave the property blank.XML Tag Attributes
Description The XML Tag Attributes property enables you to enter XML attributes. you need to enter a value for this property. If you use this method. Attributes must refer to columns or variables that occur at the same or lower frequency
•
XML Tag Attributes Example (group-level)
Suppose your tabular report uses the following query: SELECT * FROM DEPT Your default XML output looks like the following:
<MODULE2> <LIST_G_DEPTNO> <G_DEPTNO> <DEPTNO>10</DEPTNO> <DNAME>ACCOUNTING</DNAME> <LOC>NEW YORK</LOC> </G_DEPTNO> <G_DEPTNO> <DEPTNO>20</DEPTNO> <DNAME>RESEARCH</DNAME>
Report Builder Reference
447
. Applies to report. The other method is to assign a separate tag for each type (group or column) of data. or column Required/Optional Optional Default Blank Syntax XML attributes must be entered as space-separated. group. Usage Notes • Any data object added to another XML tag as an attribute should itself be excluded from XML output to minimize redundancy. The report object name can be any column or user parameter in the report. For example: XML Tag Attributes:
[attribute name]="&[report object name]"
where the text within square brackets ([ ]) is chosen by you. In this case. name-value pairs. See XML Tag Attributes example (group level) for more information. Using tag attributes is one method of organizing your XML output. You may add as many attributes to this property field as you wish by leaving a space between each one. The purpose of adding an attribute to an object’s tag is to further describe or pinpoint the data value for that tag.

specify the following properties for the DEPTNO column:| XML Tag: XML Tag Attributes: DEPTNO NAME="&DNAME" LOCATION="&LOC"
where &DNAME is a department name and &LOC is the location of that department. set the Exclude from XML Output property to Yes for the DNAME and LOC columns: The resulting XML output will look like this:
<G_DEPTNO> <DEPTNO NAME="ACCOUNTING" LOCATION="NEW YORK">10</DEPTNO> </G_DEPTNO> <G_DEPTNO> <DEPTNO NAME="RESEARCH" LOCATION="DALLAS">20</DEPTNO> </G_DEPTNO> <G_DEPTNO> <DEPTNO NAME="SALES" LOCATION="CHICAGO">30</DEPTNO> </G_DEPTNO> <G_DEPTNO> <DEPTNO NAME="OPERATIONS" LOCATION="BOSTON">40</DEPTNO> </G_DEPTNO>
XML Tag Attributes Example (report-level)
The following example demonstrates how a report-level attribute might be useful in XML. values for DNAME and LOC are now output twice: once as attributes and once as XML elements.
448
Report Builder Reference
. From the data model. In order to eliminate them as XML elements. Both objects repeat at the same frequency as DEPTNO.<LOC>DALLAS</LOC> </G_DEPTNO>
You want to generate XML output that folds all data associated with a given department number (DEPTNO) into each department number’s <DEPTNO> element. This enables you to reduce output elements from many to few. From the data model. The new XML output resembles the following:
<G_DEPTNO> <DEPTNO NAME="ACCOUNTING" LOCATION="NEW YORK">10</DEPTNO> <DNAME>ACCOUNTING</DNAME> <LOC>NEW YORK</LOC> </G_DEPTNO> <G_DEPTNO> <DEPTNO NAME="RESEARCH" LOCATION="DALLAS">20</DEPTNO> <DNAME>RESEARCH</DNAME> <LOC>DALLAS</LOC> </G_DEPTNO>
As you can see. you must also use the Exclude from XML Output property.

Click the plus sign to the left of User Parameters. find user parameters under Data Model. Double-click the query (Q_1) in the data model. 1. For the purpose of this example. job. Next you add a user parameter to your report that will select or exclude data according to hiredate. you have selected the DEPTNO and JOB columns in the data model and set the Break Order property to Descending. job. Your data model looks like the following: (See the on-line help to view the data model) Your XML output begins as follows:
<MODULE2> <LIST_G_DEPTNO> <G_DEPTNO> <DEPTNO>30</DEPTNO> <LIST_G_JOB> <G_JOB> <JOB>SALESMAN</JOB> <LIST_G_ENAME> <G_ENAME> <ENAME>ALLEN</ENAME> <HIREDATE>20-FEB-81</HIREDATE> </G_ENAME> <G_ENAME> <ENAME>WARD</ENAME> <HIREDATE>22-FEB-81</HIREDATE> </G_ENAME> <G_ENAME> <ENAME>MARTIN</ENAME> <HIREDATE>28-SEP-81</HIREDATE> </G_ENAME>
For later reference. Double-click the object P_DATE.
Report Builder Reference
449
. add the following text at the end of the existing query:
where hiredate > :p_date
so that now your query reads:
Select deptno. hiredate from emp
You have designed your report as group-left. In the Object Navigator. the first three employee’s hiredate ranges from 20-FEB-81 to 28-SEP-81. hiredate from emp where hiredate > :p_date
This SQL statement directs Report Builder to create the parameter named p_date. ename. click the Datatype property field and select Date from the drop-down menu. 3. note that within department number 30. In the SQL Query Statement dialog box. you must manually change the Datatype property to Date. 2. The arrows to the left of the DEPTNO and JOB columns in the data model should now point down. with DEPTNO as the first-level group and JOB as the second-level group.Suppose your report uses the following query:
select deptno. In the Property Palette. However. ename.

you want to assign this user parameter as an attribute to the report element. Double-click the report node in the Object Navigator. now appears within the report element. A Runtime Parameter Form will appear. Enter 1-JUL-81 and click the run button. MODULE2. asking for a date value (P Date).Next. The parameter will provide the rule for inclusion or exclusion of various elements throughout the report’s XML output.
450
Report Builder Reference
. HiredateLaterThan="01-JUL-81". Run the report in Live Previewer. enter HiredateLaterThan="&p_date" in the XML Tag Attributes property field. In the Property Palette. The attribute which defines this parameter. Your XML now looks like the following: <MODULE2 HiredateLaterThan="01-JUL-81"> <LIST_G_DEPTNO> <G_DEPTNO> <DEPTNO>30</DEPTNO> <LIST_G_JOB> <G_JOB> <JOB>SALESMAN</JOB> <LIST_G_ENAME> <G_ENAME> <ENAME>MARTIN</ENAME> <HIREDATE>28-SEP-81</HIREDATE> </G_ENAME> Note that instances of the group G_ENAME with HIREDATE values before the date 1July-81 are no longer available in XML.

it will not output the XML tag. as all data is a child of the report. you will be unable to generate any XML from the report. group. Department Name. If you set the report-level Exclude from XML Output property to Yes. your XML output includes Department Number. and Location. It looks like the following:
<G_DEPTNO> <DEPTNO>10</DEPTNO> <DNAME>ACCOUNTING</DNAME> <LOC>NEW YORK</LOC> </G_DEPTNO> <G_DEPTNO> <DEPTNO>20</DEPTNO> <DNAME>RESEARCH</DNAME> <LOC>DALLAS</LOC> </G_DEPTNO> <G_DEPTNO> <DEPTNO>30</DEPTNO> <DNAME>SALES</DNAME> <LOC>CHICAGO</LOC> </G_DEPTNO> <G_DEPTNO> <DEPTNO>40</DEPTNO> <DNAME>OPERATIONS</DNAME>
Report Builder Reference
451
.g. for the selected group or column.Exclude from XML Output
Description The Exclude from XML Output property enables you to suppress both the XML tag and associated data output. This property is useful for reformatting the XML document to exclude data that may be deemed redundant or unnecessary. If you choose to exclude an object. Applies to report. specific elements. columns within groups. Required/Optional Optional Default No Values Yes No Usage Notes • This property is especially useful when you have added an object as an attribute to another element and no longer wish for that object’s data to appear as a separate element in XML output.. attributes. Currently. e. including child data. data values and child data. and column.
•
Exclude from XML Output Example (limit data output)
Suppose you want to create XML output that limits the data to a few.

From the Data Model view. Delete the XML tag G_DEPTNO from the XML Tag property field and delete the LIST_G_DEPTNO XML tag from the Outer XML Tag property field. See Outer XML Tag Property for more information. double-click the LOC column and specify the following property in the Property Palette: Exclude from XML Output: Yes
The XML output will now look like the following:
<LIST_G_DEPTNO> <G_DEPTNO> <DEPTNO>10</DEPTNO> <DNAME>ACCOUNTING</DNAME> </G_DEPTNO> <G_DEPTNO> <DEPTNO>20</DEPTNO> <DNAME>RESEARCH</DNAME> </G_DEPTNO> <G_DEPTNO> <DEPTNO>30</DEPTNO> <DNAME>SALES</DNAME> </G_DEPTNO> <G_DEPTNO> <DEPTNO>40</DEPTNO> <DNAME>OPERATIONS</DNAME> </G_DEPTNO> </LIST_G_DEPTNO>
If you wish to remove the <LIST_G_DEPTNO> or <G_DEPTNO> tag without excluding child data (such as DEPTNO or DNAME).<LOC>BOSTON</LOC> </G_DEPTNO>
You decide to remove the <LOC> tag and its associated data.
Exclude from XML Output Example (limit redundancy)
Suppose you have decided to use attributes in your XML output which now looks like this:
<G_DEPTNO> <DEPTNO NAME="ACCOUNTING" LOCATION="NEW YORK">10</DEPTNO> <DNAME>ACCOUNTING</DNAME> <LOC>NEW YORK</LOC> </G_DEPTNO> <G_DEPTNO> <DEPTNO NAME="RESEARCH" LOCATION="DALLAS">20</DEPTNO> <DNAME>RESEARCH</DNAME> <LOC>DALLAS</LOC>
452
Report Builder Reference
. select the group G_DEPTNO from the data model and open its Property Palette.

any alpha-numeric character in this property field will allow raw XML output to be generated in Report Builder.This is how you make comments in XML --> <?xml:stylesheet type="text/xsl" href="emp. processing instructions (such as a stylesheet [XSL]). However. Applies to report Required/Optional An XML declaration is required for well-formed XML output. a processing instruction (PI).0" encoding="UTF-8"?> <!-. a comment. and a DTD. Type the prolog text and click OK.this is how you do comments in XML --> Comments: <?xml:stylesheet type="text/xsl" href="emp. and a document type declaration (DTD):
<?xml version="1. Click this button to view the XML Prolog Value dialog box.0" encoding="UTF-8"?> XML Declaration: <!-.0"?> Syntax examples <?xml version="1.xsl" ?> Processing instruction (PI): Document Type <!DOCTYPE EMP_TABULAR [ <!ELEMENT EMP_TABULAR (EMP_ITEM)*> Declaration <!ELEMENT EMP_ITEM (EMPNO)> (DTD): <!ELEMENT EMPNO (#PCDATA)>
]>
XML Prolog Value Example (prolog type: text)
Suppose you want to include the prolog as text at the beginning of your XML output. Default <?xml version="1. select the report icon in the Object Navigator and display the Property Palette.XML Prolog Value
Description The XML Prolog Value property enables you to edit the values of the XML Prolog that should appear at the beginning of all well-formed XML output. With a report open in Report Builder. The following is an example of prolog text which contains (in order) an XML declaration.xsl" ?> <!DOCTYPE EMP_TABULAR [ <!ELEMENT EMP_TABULAR (EMP_ITEM)*> <!ELEMENT EMP_ITEM (EMPNO)> <!ELEMENT EMPNO (#PCDATA)> ]>
Report Builder Reference
455
. click once in the XML Prolog Value property field to view the ellipsis button. Set the following property: XML Prolog Text Type: Next. The XML prolog should include an XML declaration but can also include comments.

XML Prolog Value Example (prolog type: file)
Suppose you want to have your prolog in an external file.This is how you make comments in XML --> <?xml:stylesheet type="text/xsl" href="emp. With a report open in Report Builder. Click this button to navigate to an external file containing prolog text. a comment. The following is an example of prolog text which contains (in order) an XML declaration. set the following property at the report level: XML Prolog File Type Next.xsl" ?> <!DOCTYPE EMP_TABULAR [ <!ELEMENT EMP_TABULAR (EMP_ITEM)*> <!ELEMENT EMP_ITEM (EMPNO)> <!ELEMENT EMPNO (#PCDATA)> ]>
456
Report Builder Reference
. a processing instruction (PI).0" encoding="UTF-8"?> <!-. click once in the XML Prolog Value property field to view the ellipsis button. and a document type declaration (DTD):
<?xml version="1.

You now want to view the hierarchical structure of your XML output for groups in your report. with a LIST_ prefix.Outer XML Tag
Description The Outer XML Tag property field displays the name of the selected group. In a report. From the data model. you can see that for the group G_DEPTNO (represented by the outer tag <LIST_G_DEPTNO>) there are three unique instances of DEPTNO data.<MODULE1> . 20.g. The purpose of the outer XML tag is to enclose all tags and data from instances of a group object. G_JOB. If
Report Builder Reference
457
. Now you wish to see the next-level group. but this might only be useful if you have only one instance of a group in your report’s query. 1. Applies to group Required/Optional Optional Default <LIST_G_[groupname]> Usage Note • You may leave this field blank. you may have repeating instances of a group object (e. For the purposes of this example. select the column DEPTNO and open the Property Palette. The outer XML tag simply encapsulates data for all repeating instances.).<LIST_G_DEPTNO> + <G_DEPTNO> + <G_DEPTNO> + <G_DEPTNO> </LIST_G_DEPTNO> </MODULE1>
In the XML example above. Change the Break Order property from Ascending to Descending. Your data model will look like the following: See the on-line help for a view of the data model. 30. 2. from ascending to descending. which outputs 10. Repeat the first two steps for the column JOB. you decide to collapse all elements within the <LIST_G_DEPTNO> outer group in order to expand the structure of data one level at a time. 3.
Outer XML Tag Example
Suppose you have a report which contains the following query:
SELECT * from EMP
You have decided to view this data as a group-left report with DEPTNO as the first-level group and JOB as the second-level group.
. Since you have made the group G_JOB a child of group G_DEPTNO. deptno. etc. which is a child of G_DEPTNO. you wish to reverse the order of output for the groups DEPTNO and JOB.

<G_EMPNO>.<LIST_G_DEPTNO> . instances of <G_EMPNO> appear.<LIST_G_EMPNO> . The XML output looks like the following: .<LIST_G_JOB> + <G_JOB> + <G_JOB> + <G_JOB> . but there are a number of column values available for the G_EMPNO group. If you expand +<LIST_G_EMPNO>. + <LIST_G_JOB> contains repeating instances of <G_JOB>. you will see the following XML output in its place: .<G_JOB> <JOB>SALESMAN</JOB> + <LIST_G_EMPNO> </G_JOB> As you can see. you will see the following XML output in its place:
.</LIST_G_JOB>
If you expand the first G_JOB element (+<G_JOB>).you expand the first XML tag <G_DEPTNO> you will see the following:
.<MODULE1> . <G_JOB> contains instances of another repeating group.<G_EMPNO> <EMPNO>7499</EMPNO> <ENAME>ALLEN</ENAME> <MGR>7698</MGR> <HIREDATE>20-FEB-81</HIREDATE> <SAL>1600</SAL> <COMM>300</COMM> </G_EMPNO> </LIST_G_EMPNO>
458
Report Builder Reference
. In this case.<G_DEPTNO> <DEPTNO>30</DEPTNO> + <LIST_G_JOB> </G_DEPTNO> + <G_DEPTNO> + <G_DEPTNO> <LIST_G_DEPTNO> </MODULE1>
Just as <LIST_G_DEPTNO> contains repeating instances of <G_DEPTNO>. If you expand the element + <LIST_G_JOB>. there will be no further child groups.

2. From the data model. 3. Usage Notes • Keep in mind that any data object added to another XML tag as an attribute should itself be excluded from XML output to minimize redundancy. The purpose of adding an attribute to an outer tag is to further describe or pinpoint the data value for that tag.
•
Outer XML Attributes Example
Suppose your report uses the following query: SELECT deptno. For the purposes of this example.Outer XML Attributes
Description The Outer XML Attributes property enables you to enter XML attributes for an outer XML tag. 1. Applies to group Required/Optional Optional Default Blank Syntax Outer XML attributes must be entered as space-separated. you wish to reverse the order of output for the groups DEPTNO and JOB. select the column DEPTNO and open the Property Palette. For example: Outer XML Tag Attributes:
[attribute name]="&[report object name]"
where the text within square brackets ([ ]) is chosen by you. job. sal FROM EMP You have decided to view this data as a group-left report with DEPTNO as the first-level group and JOB as the second-level group. your XML output looks like the following: <MODULE1> <LIST_G_DEPTNO> <G_DEPTNO>
460
Report Builder Reference
. See Exclude from XML Output for more information. Repeat the first two steps for the column JOB. Attributes must refer to columns or variables that occur at a lower frequency. Your data model will look like the following: See the on-line help for a view of the data model. ename. Currently. name-value pairs (as with HTML attributes). from ascending to descending. Change the Break Order property from Ascending to Descending. You may add as many attributes to this property as you wish by leaving a space between each one.

and substitute a unique value in the place of &p_dest in XML output. Applies to column with a source datatype of character Required/Optional Optional Default No
Contains XML Tags Example
Suppose your database already has XML tags included in the values of a column. respectively..DESTINATION&gt. If the Contains XML Tags property is set to Yes. If you set the property to Yes.JOB&gt. Report Builder does not convert XML syntax-related characters. >.DESTINA TION&gt.&amp.Contains XML Tags
Description The Contains XML Tags property indicates whether or not a report column contains XML tags. and &amp. Variable column value with XML tag: Original Text String in column: Contains XML Tags = Yes: Contains XML Tags = No:
<DESTINATION>&p_dest<DESTINATION> <DESTINATION>FIJI<DESTINATION> &lt.p_dest&lt. This is true for any value in a column with the syntax of "&[report object name]". Report Builder will recognize <DESTINATION> as an XML tag. &gt.
Non-variable column value with XML tag: Original Text String in column: Contains XML Tags = Yes: Contains XML Tags = No:
<JOB>Clerk<JOB> <JOB>Clerk<JOB> &lt. the XML tag DESTINATION represents a user-specified parameter called &p_dest. interpret &p_dest as a changing value according to user specifications.
Report Builder Reference
463
. and & to &lt. In the first instance below.JOB&gt.Clerk&lt. such as <.

464
Report Builder Reference
.

Executables
Report Builder Reference
465
.

466
Report Builder Reference
.) In addition.Executable names
Letters are appended to the executable names listed above to indicate if the GUI mode of the executable is something other than the native GUI. For example. "a" indicates a GUI mode of Apple MacIntosh and "m" a GUI mode of Motif. (No added letter means the executable’s GUI mode is the native GUI. an "x" is used to indicate if user exits are linked to the executable.

you enter the executable arguments on the command line after the executable name. If you invoke the executable via command line.Executable invocation
Executables can be invoked in one of two ways:
n by command line n by double-clicking the executable’s icon Executable Arguments When you invoke an executable.
Report Builder Reference
467
. you can enter executable arguments that govern how the executable behaves.

you can view an executable’s command line options by typing the executable’s name.. an intermediary dialog box may appear where you can enter values for the executable arguments or you may need to use the Runtime Values and Runtime Parameters tab on the Preferences dialog box (Tools Preferences) for executable arguments. you must enter four single quotes (PL/SQL collapses two quotes to one and so does Reports). you need to enter rwrun60 "?". For example:
rwrun60 module=myrep destype=file desname=run. to view the command line options for the RWRUN60 executable in the UNIX C shell. DESNAME. n The keyword= part of all arguments is not case sensitive.g. DESFORMAT. CMDFILE. and then pressing Return. n To pass a single quote from the command line. Note: Some operating systems require quotes around the question mark. do not use commas to separate arguments. The value portion of all other arguments is not case sensitive. DEST. For example. Apple Macintosh or Windows) and you invoke the executable via icon. n Separate arguments with one or more spaces.
n If your operating system does not have a command line available (e. n Each keyword=value is called an executable argument. For example. rwrun60 "?". n Keywords may sometimes be omitted. they may be omitted.Help on command line options
If you are on a command line. n Values of arguments may be in single or double quotes. if you wanted to
468
Report Builder Reference
. TERM.. and SNAME arguments may be case sensitive. DNAME. For example. then a space and a question mark. n No spaces should be placed before or after the equal sign of an argument.out batch=yes p_value="Roy’’s Batch Report"
To pass a parameter value with a single quote in it using the Forms RUN_PRODUCT packaged procedure. The value portion of the SOURCE. Because it would be cumbersome to enter the keywords each time.. depending on your operating system. The effect of single or double quotes is operating system-specific. it generally has the form shown below:
executable_name keyword1=value1 keyword2=value2 . you must enter two quotes (one quote as an escape and one as the actual quote). Executable syntax restrictions
n When you enter an executable on the command line.

if you specified RWRUN60 on the command line with COPIES equal to 1. etc. You can specify values for DESTYPE. n Full pathnames are supported for all file references (e. REPORTS30_PATH enables you to access files stored outside of Report Builder or Reports Runtime without hardcoding directory paths into your report. you can use the environment variable REPORTS30_PATH for referencing reports. If you do not specify the full path. Note: To help ensure the portability of your reports. external queries. If you enter an empty string in this way. external PL/SQL libraries. DESFORMAT. For example. n Values entered from the Runtime Parameter Form override those entered on the command line. the file path search order is used to find the file. the Runtime Parameter Form will display an empty string for the argument instead of its Initial Value. the second takes precedence over all but the first item. then two copies of the report would be generated. In RUNONE. The following list shows the order of precedence for the places where you specify these values. text files. For example. values entered on the command line override values specified in command files. but. and so on:
n Print Job dialog box n Runtime Parameter Form n Runtime Parameters/Settings tab of Tools Options or Runtime Options dialog box n keywords on the command line n values specified in the report definition n Choose Printer dialog
Report Builder Reference
469
. suppose that you specify RWRUN60 from the command line with COPIES equal to 1 and CMDFILE equal to RUNONE (a command file). COPIES is set to 2 by a RWRUN60 command. The first item in the list takes precedence over all others.pass the following literal value to an Reports’ parameter:
where ’=’
you would enter the following string in RUN_PRODUCT:
’where ’’’’=’’’’’
n To give an argument an empty string as its value. ORIENTATION. in the Runtime Parameter Form. DESNAME.
Similarly.. you enter keyword= or keyword="". specified COPIES equal to 2. Only one copy of the report would be generated in this case. desname=/revenues/q1/nwsales). and COPIES in a number of different places. graphics.g.

the rest of the arguments on the command line must also use keywords. and fourth arguments. second.
470
Report Builder Reference
.
rwrun60 scott/tiger mail rmiller no
The sequence above is invalid because the value NO has been entered out of order and without the PARAMFORM keyword. too.Keyword usage
The keyword= part of each argument is optional as long as the arguments are entered in the order specified by the syntax. Once you have entered a keyword. If you skip one of the arguments. after the keyword DESTYPE is used all subsequent arguments use keywords. If an executable has four arguments and you want to specify only the first. The fourth would require a keyword. because you are not entering it in the order specified by the syntax. you must use keywords after the skipped argument. Examples (Invalid): Below are examples of invalid command line sequences:
rwrun60 paramform=no scott/tiger destype=mail desname=rmiller
The sequence above is invalid because scott/tiger has been typed out of order and without the USERID keyword. you can specify the first two without the keywords. though. in this example. Examples (Valid): Below are examples of valid command line sequences:
rwrun60 userid=scott/tiger paramform=no destype=mail desname=rmiller rwrun60 scott/tiger no destype=mail desname=rmiller
Notice that.

Explicit login
You explicitly login to the database by using the USERID keyword. or by choosing File Connect.
472
Report Builder Reference
.

If you omit your password. a logon screen is provided. For more information about automatic login. Values The logon definition must be in one of the following forms and cannot exceed 512 bytes in length:
username[/password] username[/password][@database]
[user[/password]]@ODBC:datasource[:database] or [user[/password]]@ODBC:*
Report Builder Reference
473
.USERID
Description USERID is your ORACLE username and password with an optional database name. see "Remote Login". SQL*Net communication protocol to access a remote database. or ODBC datasource name (if accessing a non-Oracle datasource). For more information about the optional SQL*Net communication protocol. see "Automatic Login".

To invoke an automatic login procedure. see the ORACLE8 Server SQL Language Reference Manual. Omit your username/password on the command line and press the Return or Enter key twice when the logon form appears.
Note: When logging on in this way.
474
Report Builder Reference
. do one of the following:
n n n
Type rwconv60 / on the command line. you can access a remote login by typing @database after the slash. For more information on default logons. OPS$) to associate your ORACLE username to your operating system username.Automatic login
The ORACLE automatic login feature allows you to connect to the database without explicitly stating a username and password.. ORACLE uses a default logon (e.g. When you connect in this way. Type a slash (/ ) in the logon screen as your username.

you must have an account on the remote computer node where the target database resides. one not on your computer). the remote database is transparent to you. When you use the remote login feature. you can specify a remote database (i.
Report Builder Reference
475
. For more information on SQL*Net.Remote login
Through SQL*Net.e. Usage Notes
n To perform a remote connect. refer to your SQL*Net documentation..

If ACCESS is not specified. Report Builder will look in the location specified with the ACCESS keyword for the module. then opens the report using a page size of 8.) If you do not specify a report using MODULE|REPORT.MODULE|REPORT (RWBLD60)
Description MODULE|REPORT is a module (report. Report Builder will start up with a new report definition open. If the module is not found. Report Builder will use its file path search order. (REPORT is allowed for backward compatibility. Usage Notes
n If you open a character mode report via bit-mapped RWBLD60. or external PL/SQL library name. Report Builder will start up without opening the specified module.
Report Builder Reference
479
. Report Builder displays a warning.5" x 11" and a form size of 7" x 6". Syntax
[MODULE|REPORT=]runfile
Values Any valid report. external query. or external PL/SQL library) that you want to open in Report Builder. external query.

This option enables you to run a report without having to specify a large number of arguments each time you invoke RWBLD60. For example. Usage Notes
n A command file may reference another command file. Syntax
[CMDFILE=]cmdfile
Values Any valid command file. suppose that you specify RWBLD60 from the command line with COPIES equal to 1 and CMDFILE equal to RUNONE (a command file). n The argument(s) for this keyword may be operating system-specific. see Executable Syntax Restrictions. For more information. Only one copy of the report would be generated in this case.
Report Builder Reference
481
. In RUNONE. COPIES is set to 2.CMDFILE (RWBLD60)
Description CMDFILE is a file that contains arguments for the RWBLD60 command. n Command file syntax for RWBLD60 arguments is identical to that used on the command line. n Values entered on the command line override values specified in command files.

ARRAYSIZE (RWBLD60)
Description ARRAYSIZE is the size of the array in kilobytes for use with ORACLE array processing. Syntax
[ARRAYSIZE=]n
Values A number from 1 through 9. Default The default arraysize is 10.999. This means that Report Builder can use this number of kilobytes of memory per query in your report. For details on ORACLE array processing.
482
Report Builder Reference
. see the Oracle8 Server Administrator’s Guide.

Sends the output to the mail IDs specified in DESNAME. Routes the output to the Previewer for interactive viewing.
n n
Report Builder Reference
483
.) The appearance of the dialog box varies between operating systems. the Print Job dialog box will appear after you accept the Runtime Parameter Form. the report is executed and the output is sent to the printer (specified in File Choose Printer). or MAIL. this parameter may be overridden by your operating system. (If DESTYPE is something other than PRINTER. The Previewer will use DESNAME to determine which printer’s fonts to use to display the output. FILE. However. If you set DESTYPE to PRINTER.DESTYPE (RWBLD60)
Description DESTYPE is the type of destination device that will receive the report output. unless it is suppressed. Some DESTYPE values are not supported on some operating systems. Syntax
[DESTYPE=]{SCREEN|FILE|PRINTER|PREVIEW|MAIL}
Values SCREEN FILE PRINTER PREVIEW
MAIL
Routes the output to the Previewer. Usage Notes
n n
SYSOUT is not a valid option for DESTYPE while using RWBLD60. SYSOUT can only be used with RWRUN60 when BATCH=YES.
Default Taken from the Initial Value property of the DESTYPE parameter. In some cases. The report is sent as an attached file. You can send mail to any mail system that is MAPI-compliant or has the service provider driver installed. file. FILE. or mail ID. or MAIL. After you accept the Print Job dialog box. Preview causes the output to be formatted as PostScript output. then the report is executed after you accept the Runtime Parameter Form. Routes the output to the printer named in DESNAME. Saves the output to a file named in DESNAME.

If DESTYPE=FILE and DESNAME is an empty string. . (name. or email ID not to exceed 1K in length. name.DESNAME (RWBLD60)
Description DESNAME is the name of the file. you can optionally specify a port. n If DESTYPE is PREVIEW. this parameter may be overridden by your operating system. printer. n The argument(s) for this keyword may be case sensitive.FILE:
Default Taken from the Initial Value property of the DESNAME parameter. For example:
DESNAME=printer.g. Usage Notes
n This keyword is ignored if DESTYPE is SCREEN.. it defaults to reportname.
484
Report Builder Reference
. To send the report output via email. depending on your operating system. Syntax
[DESNAME=]desname
Values Any valid filename.name)). printer name.lis at runtime. You can specify multiple usernames by enclosing the names in parentheses and separating them by commas (e. Report Builder uses DESNAME to determine which printer’s fonts to use to display the output. or email ID (or distribution list) to which the report output will be sent. . specify the email ID as you do in your email application (any MAPI-compliant application on Windows or your native mail application on UNIX).LPT1: DESNAME=printer. For printer names. n In some cases. .

The drivers for the currently selected printer is used to produce the output.g. Note that when you open the file in MS Word.DESFORMAT (RWBLD60)
Description In bit-mapped environments. Syntax
[DESFORMAT=]desformat
Values Any valid destination format not to exceed 1K in length. the default delimiter is a TAB. HTML Means that the report output will be sent to a file that can be read by an HTML 3. you must have a printer configured for the machine on which you are running the report. DESFORMAT specifies the printer driver to be used when DESTYPE is FILE.0 compliant browser (e. it specifies the characteristics of the printer named in DESNAME. etc. In character-mode environments.x. DELIMITED Means that the report output will be sent to a file that can be read by standard spreadsheet utilities. decwide. PDF Means that the report output will be sent to a file that can be read by a PDF viewer. HTMLCSS Means that the report output sent to a file will include style sheet extensions that can be read by an HTML 3. Examples of valid values for this keyword are hpl. Default
Report Builder Reference
485
. decland.0 compliant browser that supports cascading style sheets. dec180. Ask your System Administrator for a list of valid destination formats. including a fifthgeneration or higher web browser.. Netscape 2. RTF Means that the report output will be sent to a file that can be read by standard word processors (such as Microsoft Word). Note that if you do not choose a delimiter. hplwide. such as Microsoft Excel. XML Means that the report output will be sent to a file that can be read by any XML-supporting application. HTMLCSSIE Means that the report output sent to a file will include style sheet extensions that can be read by Microsoft Internet Explorer 3.2). PDF output is based upon the currently configured printer for your system. wide. dec. you must choose View Page Layout to view all the graphics and objects in your report.. dflt.

For bit-mapped Report Builder. then the current printer driver (specified in File Choose Printer) is used.Taken from the Initial Value property of the DESFORMAT parameter.
486
Report Builder Reference
. if DESFORMAT is blank or dflt. If nothing has been selected in Choose Printer. n The value(s) for this keyword may be case sensitive. Usage Notes
n This keyword is ignored if DESTYPE is SCREEN. depending on your operating system. then Postscript is used by default.

999. it defaults to one. Syntax
[COPIES=]n
Values Any valid integer from 1 through 9. Default Taken from the Initial Value property of the COPIES parameter. n If COPIES is left blank on the Runtime Parameter Form.
Report Builder Reference
487
. Usage Notes
n This keyword is ignored if DESTYPE is not Printer.COPIES (RWBLD60)
Description COPIES is the number of copies of the report output to print.

n If the location of the temporary file directory does not have sufficient available disk space. NO means to not cache the LOB in the temporary file directory. it is preferable to set this value to NO. Setting the value to NO. may decrease performance.CACHELOB (RWBLD60)
Description CACHELOB specifies whether to cache retrieved Oracle8 large object(s) in the temporary file directory (specified by REPORTS60_TMP). however. Values YES means to cache the LOB in the temporary file directory.
488
Report Builder Reference
. Default YES Usage Notes
n You can only set this option on the command line. as the LOB may need to be fetched from the server multiple times.

Default The default for ORACLE is determined by the ORACLE National Language Support facilities.CURRENCY (RWBLD60)
Description CURRENCY is the currency character to be used in number formats.
Report Builder Reference
489
. Syntax
[CURRENCY=]currency_symbol
Values Any valid alphanumeric string not to exceed 1K in length. You can also set a default of up to four characters in the Initial Value property of the CURRENCY parameter. Usage Notes
n A CURRENCY value entered in Property Palette will override any CURRENCY value entered on the command line.

" is returned." as the THOUSANDS value. For example. ". You can also set a default of up to four characters in the Initial Value property of the THOUSANDS parameter. Usage Notes
n A THOUSANDS value entered on the Parameter property sheet will override any THOUSANDS value entered on the command line. n The alphanumeric character defined as the THOUSANDS value is the actual value that is returned.
490
Report Builder Reference
. if you define ". Syntax
[THOUSANDS=]thousands_symbol
Values Any valid alphanumeric character.THOUSANDS (RWBLD60)
Description THOUSANDS is the thousands character to be used in number formats. Default The default for ORACLE is determined by the ORACLE National Language Support facilities.

Default The default for ORACLE is determined by the ORACLE National Language Support facilities. Usage Notes
n A DECIMAL value entered on the Parameter property sheet will override any DECIMAL value entered on the command line. Syntax
[DECIMAL=]decimal_symbol
Values Any valid alphanumeric character. n The alphanumeric character defined as the DECIMAL value is actual value that is returned.
Report Builder Reference
491
. if you define “. You can also set a default in the Initial Value property of the DECIMAL parameter.DECIMAL (RWBLD60)
Description DECIMAL is the decimal character to be used in number formats.” is returned. For example. “.” as the DECIMAL value.

because ORACLE automatically provides read consistency. NO means do not provide read consistency. for single query reports.
492
Report Builder Reference
. When accessing data from ORACLE.READONLY (RWBLD60)
Description READONLY requests read consistency across multiple queries in a report. notice where the SET TRANSACTION READONLY occurs. Default NO Usage Notes
n
This keyword is only useful for reports using multiple queries. Syntax
[READONLY=]{YES|NO}
Values YES requests read consistency. without locking.
READONLY Restrictions
n In Report trigger order of execution. read consistency is accomplished by a SET TRANSACTION READ ONLY statement (refer to your Oracle8 Server SQL Language Reference Manual for more information on SET TRANSACTION READ ONLY).

the upper limit may be lower. Default 640K Usage Notes
n If this setting is changed in the middle of your session.BUFFERS (RWBLD60)
Description BUFFERS is the size of the virtual memory cache in kilobytes. You should tune this setting to ensure that you have enough space to run your reports. For some operating systems.
Report Builder Reference
493
. the change does not take effect until the next time the report is run. Syntax
[BUFFERS=]n
Values A number from 1 through 9. but not so much that you are using too much of your system’s resources.999.

e.5 inches.5 x 11 inches. For example. where page width and page height are zero or more. the maximum width/height is 512 inches. it is 1312 centimeters. 80 x 66 characters. The maximum width/height depends upon the unit of measurement. If this keyword is used. Note that the page must be large enough to contain the report. it is 36. if a frame in a report expands to a size larger than the page dimensions. A PAGESIZE value entered on the Runtime Parameter Form will override any PAGESIZE value entered on the command line.PAGESIZE (RWBLD60)
Description PAGESIZE is the dimensions of the physical page (i.5 x 11 inches. the report will not run. For example. if the character page size is 80 x 20. the following formula is used to determine page size if none is specified: (default page size * character page size)/default character page size. the bit-mapped page size would be: (8. Usage Notes
n
On some printers the printable area of the physical page is restricted.864 picas. its value overrides the page dimensions of the report definition. you can either increase the printable area for the printer (if your operating system allows it) or you can set the page width x page height to be the size of the printable area of the page. 8. If the report was designed for character mode and is being run or converted on bitmap.5 * 80)/80 x (11 * 20)/66 = 8.
n n
494
Report Builder Reference
. but the printer might only be able to print on an area of 8 x 10. For inches.33. For character mode. the size of the page that the printer outputs). Default For bitmap. the sheet of paper a printer takes may be 8. For picas.5 x 3.. To avoid clipping. clipping may occur in your report output. For example. For centimeters. Syntax
[PAGESIZE=]width x height
Values Any valid page dimensions of the form: page width x page height. If you define a page width x page height in Report Builder that is bigger than the printable area your printer allows.

parse the SQL. Time is the amount of time spent in Report Builder. PROFILE calculates the following statistics:
n
TOTAL ELAPSED TIME is the amount of time that passes between when you issue RWBLD60 and when you leave the designer.
n n n n n
Note: For some operating systems.DO_SQL. the Report Builder time includes the database time because the database is included in Report Builder’s process. TOTAL ELAPSED TIME is the sum of Report Builder Time and ORACLE Time.PROFILE (RWBLD60)
Description PROFILE is the name of a file in which you want to store performance statistics on report execution. ORACLE Time is the amount of time spent in the database and is composed of the following: UPI is the amount of time spent to do such things as connect to the database. and fetch the data. Report Builder calculates statistics on the elapsed and CPU time spent running the report. Syntax
[PROFILE=]profiler_file
Values Any valid filename in the current directory. If you specify a filename.
Report Builder Reference
495
. SQL is the amount of time spent performing SRW. TOTAL CPU Time used by process is the CPU time spent while in the designer.

Default YES
496
Report Builder Reference
. RUNDEBUG checks for the following:
n frames or repeating frames that overlap but do not enclose another object. Report Builder will make such objects fixed in size regardless of the Vertical and Horizontal Elasticity properties.RUNDEBUG (RWBLD60)
Description RUNDEBUG is whether you want extra runtime checking for logical errors in reports. n layout objects with page-dependent references that do not have fixed sizing. Syntax
[RUNDEBUG=]{YES|NO}
Values YES means perform extra runtime error checking. n bind variables referenced at the wrong frequency in PL/SQL. This can lead to objects overwriting other objects in the output. RUNDEBUG checks for things that are not errors but might result in undesirable output. NO means do not perform extra runtime error checking.

NOACTION. Oracle Forms) with no USERID provided. NOACTION means do nothing when a report is done. ROLLBACK means perform a ROLLBACK when a report is done. if a USERID is provided.g.. if called from an external source (e. Usage Notes
n The COMMIT or ROLLBACK for ONSUCCESS is performed after the After Report trigger fires. Syntax
[ONSUCCESS=]{COMMIT|ROLLBACK|NOACTION}
Values COMMIT means perform a COMMIT when a report is done. see READONLY. Default COMMIT.ONSUCCESS (RWBLD60)
Description ONSUCCESS is whether you want a COMMIT or ROLLBACK performed when a report is finished executing. For more information.
Report Builder Reference
497
. Other COMMITs and ROLLBACKs can occur prior to this one.

if called from an external source (e. NOACTION. Oracle Forms) with no USERID provided. Usage Notes
n The COMMIT or ROLLBACK for ONFAILURE is performed after the report fails.ONFAILURE (RWBLD60)
Description ONFAILURE is whether you want a COMMIT or ROLLBACK performed if an error occurs and a report fails to complete. Syntax
[ONFAILURE=]{COMMIT|ROLLBACK|NOACTION}
Values COMMIT means perform a COMMIT if a report fails.. ROLLBACK means perform a ROLLBACK if a report fails. see READONLY. NOACTION means do nothing if a report fails.g. if a USERID is provided. Default ROLLBACK.
498
Report Builder Reference
. For more information. Other COMMITs and ROLLBACKs can occur prior to this one.

ERRFILE (RWBLD60)
Description ERRFILE is the name of a file in which you want Report Builder to store error messages. Syntax
[ERRFILE=]error_file
Values Any valid filename.
Report Builder Reference
499
.

Default 10K
500
Report Builder Reference
. Syntax
[LONGCHUNK=]n
Values A number from 1 through 9.LONGCHUNK (RWBLD60)
Description LONGCHUNK is the size (in kilobytes) of the increments in which Report Builder retrieves a LONG column value. When retrieving a LONG value. you may want to retrieve it in increments rather than all at once because of memory size restrictions. the upper limit may be lower. For some operating systems. LONGCHUNK applies only to Oracle7 and Oracle8.999.

Report Builder will search in this location for the module you specify with MODULE. Syntax
[ACCESS=]{FILE|DATABASE}
Values FILE DATABASE Default FILE
Report Builder Reference
501
. Report Builder will use its file path search order to find the file.ACCESS (RWBLD60)
Description ACCESS is the location from which modules should be opened. If ACCESS is not specified.

Syntax
[BACKGROUND=]{YES|NO}
Values YES is not a valid option for RWBLD60. NO Default NO
Report Builder Reference
503
.BACKGROUND (RWBLD60)
Description BACKGROUND specifies whether the report should be run in the background.

MODE (RWBLD60)
Description MODE specifies whether to run the report in character mode or bitmap. if you want to send a report to a Postscript printer from a terminal (e. Syntax
[MODE=]{BITMAP|CHARACTER|DEFAULT}
Values BITMAP DEFAULT means to run the report in the mode of the current executable being used.. CHARACTER Default DEFAULT
504
Report Builder Reference
. For example. This enables you to run a character-mode report from bit-mapped Report Builder or vice versa. a vt220). On Windows. you could invoke character-mode RWRUN60 and run the report with MODE=BITMAP. specifying MODE=CHARACTER means that the Report Builder ASCII driver will be used to produce editable ASCII output.g.

is called from within another executable. the Print Job dialog box will not appear. one executable. the Print Job dialog box will not appear..e. Syntax
[PRINTJOB=]{YES|NO}
Values YES or NO Default YES Usage Notes
n When a report is run as a spawned process (i. such as RWBLD60).PRINTJOB (RWBLD60)
Description PRINTJOB specifies whether the Print Job dialog box should be displayed before running a report. n When DESTYPE=MAIL.
Report Builder Reference
505
. such as RWRUN60. regardless of PRINTJOB. regardless of PRINTJOB.

n If you specify LOGFILE or ERRFILE as well as TRACEFILE. You cannot specify logging when running a .
RWRUN60 MODULE=order_entry USERID=scott/tiger TRACEFILE=trace.rdf file.log ERRFILE=err. Usage Notes
n Trace information can only be generated when running a . in the following case.rep file.log LOGFILE=mylog.log
506
Report Builder Reference
.log because it is the last file specified in the RWRUN60 command. all of the trace information will be placed in the most recently specified file. Syntax
[TRACEFILE=]tracefile
Values Any valid filename. For example. all of the specified trace information would be placed in err.TRACEFILE (RWBLD60)
Description TRACEFILE is the name of the file in which Report Builder logs trace information.

Report Builder Reference
507
. You cannot specify logging when running a . Syntax
[TRACEMODE=]{TRACE_APPEND|TRACE_REPLACE}
Values TRACE_APPEND adds the new information to the end of the file. Default TRACE_APPEND Usage Notes
n Trace information can only be generated when running a .rep file.rdf file. TRACE_REPLACE overwrites the file.TRACEMODE (RWBLD60)
Description TRACEMODE indicates whether Report Builder should add the trace information to the file or overwrite the entire file.

so you can cut and past to generate a . TRACE_ERR means list error messages and warnings in the trace file.. TRACE_APP means log trace information on all the report objects in the trace file.rep file.DST file format. Default TRACE_ALL Usage Notes
n Trace information can only be generated when running a . For example. You can use this information to determine which section was sent to which destination. You cannot specify logging when running a .)}
Values A list of options in parentheses means you want all of the enclosed options to be used. TRACE_PLS means log trace information on all the PL/SQL objects in the trace file.DST file from the trace file. TRACE_BRK means list breakpoints in the trace file. opt2. TRACE_PRF) means you want TRACE_APP and TRACE_PRF applied. TRACE_SQL means log trace information on all the SQL in the trace file.TRACEOPTS (RWBLD60)
Description TRACEOPTS indicates the tracing information that you want to be logged in the trace file when you run the report. TRACE_OPTS=(TRACE_APP. TRACE_ALL means log all possible trace information in the trace file. TRACE_PRF means log performance statistics in the trace file. TRACE_DST means list distribution lists in the trace file. TRACE_TMS means enter a timestamp for each entry in the trace file. Syntax
[TRACEOPTS=]{TRACE_ERR|TRACE_PRF|TRACE_APP|TRACE_PLS| TRACE_SQL|TRACE_TMS|TRACE_DST|TRACE_ALL|(opt1.rdf file. .. The trace file format is very similar to the .
508
Report Builder Reference
.

Default YES
510
Report Builder Reference
.NONBLOCKSQL (RWBLD60)
Description Specifies whether to allow other programs to execute while Report Builder is fetching data from the database. NO means that other programs cannot execute while data is being fetched. Syntax
[NONBLOCKSQL=]{YES|NO}
Values YES means that other programs can execute while data is being fetched.

ROLE is ignored for RWBLD60.
Report Builder Reference
511
.ROLE (RWBLD60)
Description ROLE specifies the database role to be checked for the report at runtime. Syntax
[ROLE=]{rolename/[rolepassword]}
Values A valid role and (optionally) a role password.

Syntax
[BLANKPAGES=]{YES|NO}
Values YES means print all blank pages NO means do not print blank pages Default YES Usage Notes BLANKPAGES is especially useful if your logical page spans multiple physical pages (or panels).
512
Report Builder Reference
. Use this keyword when there are blank pages in your report output that you do not want to print. and you wish to suppress the printing of any blank physical pages.BLANKPAGES (RWBLD60)
Description BLANKPAGES specifies whether to suppress blank pages when you print a report.

Report Builder Reference
513
. it should only be used with Reports Runtime. This keyword has no affect on Report Builder.MAXIMIZE (RWBLD60)
Description MAXIMIZE specifies whether to maximize the Reports Runtime window.

Syntax [DISABLENEW=]{YES|NO} Values YES or NO Default NO
Report Builder Reference
517
.DISABLENEW (RWBLD60)
Description DISABLENEW specifies whether to disable the View New Previewer menu to prevent the ability to display a new instance of the Runtime Previewer.

means a period separates each cell You can also use any of these four reserved values: tab means a tab separates each cell space means a space separates each cell return means a new line separates each cell none means no delimiter is used You can also use escape sequences based on the ASCII character set. Syntax [DELIMITER=]value Values Any alphanumeric character or string of alphanumeric characters. such as: . such as: \t means a tab separates each cell \n means a new line separates each cell Default Tab Usage Notes
n This argument can only be used if you’ve specified DESFORMAT=DELIMITED. means a comma separates each cell .
518
Report Builder Reference
.DELIMITER (RWBLD60)
Description DELIMITER specifies the character(s) to use to separate the cells in your report output.

Report Builder Reference
519
. Syntax [CELLWRAPPER=]value Value Any alphanumeric character or string of alphanumeric characters. such as: \t means a tab displays on each side of the cell \n means a new line displays on each side of the cell Default None Usage Notes
n This argument can only be used if you’ve specified DESFORMAT=DELIMITED. n The cell wrapper is different from the actual delimiter . “ means a double quotation mark displays on each side of the cell ‘ means a single quotation mark displays on each side of the cell You can also use any of these four reserved values: tab means a tab displays on each side of the cell space means a single space displays on each side of the cell return means a new line displays on each side of the cell none means no cell wrapper is used You can also use escape sequences based on the ASCII character set.CELLWRAPPER (RWBLD60)
Description CELLWRAPPER specifies the character(s) that displays around the delimited cells in your report output.

522
Report Builder Reference
.DST
Values The name of a . Usage Notes
n
To enable the DESTINATION keyword.DST file.DESTINATION (RWBLD60)
Description The DESTINATION keyword allows you to specify the name of a .DST file that defines the distribution for the current run of the report. you must specify DISTRIBUTE=YES on the command line. Syntax
[DESTINATION=]filename.

you must specify DISTRIBUTE=YES. This is fundamentally a debug mode to allow running a report set up for distribution without actually executing the distribution. Default NO Usage Notes
n
To enable the DESTINATION keyword. Syntax
[DISTRIBUTE=]{YES|NO}
Values YES means to distribute the report to the distribution list.DISTRIBUTE (RWBLD60)
Description DISTRIBUTE enables or disables distributing the report output to multiple destinations. NO means to ignore the distribution list and output the report as specified by the DESNAME and DESFORMAT parameters.DST file. as specified by the distribution list defined in the Distribution dialog box or a .
Report Builder Reference
523
.

PL/SQL in a Before Report trigger (SRW. NO means to output the report without page streaming. Default NO
524
Report Builder Reference
. using the navigation controls set by either of the following:
n n
the Page Navigation Control Type and Page Navigation Control Value properties in the Report Property Palette.SET_PAGE_NAVIGATION_HTML)
[PAGESTREAM=]{YES|NO}
Syntax Values YES means to stream the pages.PAGESTREAM (RWBLD60)
Description PAGESTREAM enables or disables page streaming for the report when formatted as HTML or HTMLCSS output.

xcf) files.2 or greater Usage Notes domain user
Report Builder Reference
525
.
ncacn_ip_tcp:olap2pc/sl=x/st=x/ct=x/sv=x /).. st Server Type 1: Express Server ct Connection 0: Express connection Type sv Server Version 1: Express 6. is the userid to log into the Express Server. The following table describes the parameters and their settings. The server value contains four parameters that correspond to settings that are made in the Oracle Express Connection Editor and stored in connection (. Parameter Description Setting sl Server Login -2: Host (Domain Login) -1: Host (Server Login) 0: No authentication required 1: Host (Domain Login) and Connect security 2: Host (Domain Login) and Call security 3: Host (Domain Login) and Packet security 4: Host (Domain Login) and Integrity security 5: Host (Domain Login) and Privacy security Notes: Windows NT uses all the settings. password is the password for the userid. All four parameters are required and can be specified in any order. -1. and -2.g. See below for more
details on the server string. See the Express Connection Editor Help system for information on these settings.EXPRESS_SERVER (RWBLD60)
EXPRESS_SERVER specifies the Express Server to which you want to connect. Unix systems use only the settings 0. Syntax
EXPRESS_SERVER="server=[server]/domain=[domain]/ user=[userid]/password=[passwd]"
Values A valid connect string enclosed in double quotes (") where server is the Express server string (e. is the Express Server domain.

EXPRESS_SERVER with userid.g. and domain (RWBLD60) example
rwbld60 userid=scott/tiger@nt805 express_server="server=ncacn_ip_tcp:olap2-pc/sl=0/st=1/ct=0/ sv=1/" report=exp. password. n If a forward slash (/) is required in the string. the command line should be as follows:
EXPRESS_SERVER="server=ncacn_ip_tcp:olap2-pc/sl=0/ st=1/ct=0/sv=1/ domain=tools//reports"
n You can use single quotes within the string.rdf destype=file desname=exp1. you must use another forward slash as an escape character. For example.n You can have spaces in the string if necessary (e. and domain (RWBLD60) example
rwbld60 userid=scott/tiger@nt805 express_server="server=ncacn_ip_tcp:olap2-pc/sl=1/st=1/ct=0/ sv=1/user=orbuild/domain=tools/password=buildme/" report=exp. if the domain were tools/reports.rdf destype=file desname=exp1.html desformat=html batch=yes
526
Report Builder Reference
.. password. if the userid is John Smith) because the entire string is inside of quotes.html desformat=html batch=yes
EXPRESS_SERVER without userid. It is not treated specially because it is enclosed within double quotes.

g.xml|(filename1.XML. with path information prefixed to the filenames if necessary. the file extension of an XML report definition is . but it does not have to be when it is used with the CUSTOMIZE keyword. font changes or color changes) that change the report definition in some way.
Report Builder Reference
527
. For more information. Syntax
[CUSTOMIZE=]filename.xml.CUSTOMIZE (RWBLD60)
Description CUSTOMIZE specifies an XML file or list of files that you want to apply to the report selected in the MODULE or REPORT keyword.xml. …)
Values The names of files that contain valid XML report definitions.. The XML file contains customizations (e. filename2. refer to the Publishing Reports manual. Usage Notes Typically.

This argument is most useful when you have an .RDF file.
528
Report Builder Reference
. For more information. Syntax
[SAVE_RDF=]filename. refer to the Publishing Reports manual.RDF file to which you are applying an XML file via the CUSTOMIZE keyword and want to save the combination of the two to a new .rdf
Values Any valid filename.SAVE_RDF (RWBLD60)
Description SAVE_RDF specifies a file to which you want to save the report selected in the MODULE or REPORT keyword combined with the XML customization file(s) selected in the CUSTOMIZE keyword.

because the parameters may refer to those that have not yet been defined.
Report Builder Reference
529
. n Values of arguments may be in single or double quotes. Usage Notes
n You can override the default value on the Runtime Parameter Form. n The PARAM value is not parsed.<param> (RWBLD60)
Description <param> is a parameter that is part of the report’s definition. Default Taken from the Initial Value property of the parameter. or validated. Syntax
<param>=value
Values Any valid value for that parameter. The effect of single or double quotes is operating-system specific. The value you specify for the parameter is used for that parameter’s value.

htm. refer to d2kcfg. allowing you to run reports dynamically from your Web browser.
530
Report Builder Reference
. For more information about RWCGI60.RWCGI60
Description RWCGI60 is the Reports Web CGI executable that provides a connection between a Web Server and the Reports Server (RWMTS60).

Syntax
RWCLI60 MODULE|REPORT=runfile USERID=userid [ [keyword=]value|(value1. n If the command line contains CMDFILE=.) ] SERVER=tnsname
where keyword=value is a valid command line argument.RWCLI60
Description RWCLI60 parses and transfers the command line to the specified Reports Server (RWMTS60). except for command file.. The runtime engine will not re-read the command file. It uses a command line very similar to RWRUN60.
Report Builder Reference
531
. Usage Notes
n All file names and paths specified in the client command line refer to files and directories on the server machine. the command file will be read and appended to the original command line before being sent to the Reports Server. .. value2.

You can send mail to any mail system that is MAPI compliant or has the service provider driver installed. Sends the output to the client machine’s default output device and forces a synchronous call. Usage Notes
n Screen and Preview cannot be used for DESTYPE with RWCLI60.DESTYPE (RWCLI60)
Description DESTYPE is the type of device that will receive the report output. regardless of the BACKGROUND value. Syntax
[DESTYPE=]{CACHE|LOCALFILE|FILE|PRINTER|SYSOUT|MAIL}
Values CACHE
LOCALFILE FILE PRINTER MAIL
SYSOUT
Sends the output directly to the Reports Server’s cache.
Report Builder Reference
535
. Sends the output to the file on the server machine named in DESNAME. Note that DESTYPE=CACHE is not compatible with the DISTRIBUTE keyword. The report is sent as an attached file.
Default Taken from the Initial Value property of the DESTYPE parameter. Sends the output to the printer on the server machine named in DESNAME. If the server encounters DISTRIBUTE on the command line. Sends the output to the mail users specified in DESNAME. Sends the output to a file on the client machine and forces a synchronous call. it will ignore the DESTYPE=CACHE command line argument.

Syntax
[BACKGROUND=]{YES|NO}
Values YES or NO Default NO
Report Builder Reference
537
. and finish. be assigned to a runtime engine. run. An asynchronous call means that the client simply sends the call without waiting for it to complete. the job is canceled.BACKGROUND (RWCLI60)
Description BACKGROUND is whether the call is synchronous (BACKGROUND=NO) or asynchronous (BACKGROUND=YES). A synchronous call means that the client waits for the report to queue. If the client process is killed during a synchronous call.

the queue manager will show the report name as the job name. If it is not specified.JOBNAME (RWCLI60)
Description JOBNAME is the name for a job to appear in the Reports Queue Manager. Syntax
[JOBNAME=]string
Report Builder Reference
539
. It is treated as a comment and has nothing to do with the running of the job.

. When users successfully log on. ones sent to the secured server) must be re-authenticated. Syntax
[AUTHID=]username/password
Values Any valid username and password created in Oracle WebDB. Refer to Oracle WebDB online help for more information about Oracle Reports Security. or include the %S argument in the key mapping entry in the owscmd. omit the AUTHID command from the report request. WebDB ensures that users running the reports have the access privileges needed to run the requested report. Oracle Reports uses Oracle WebDB to perform the security check. the cookie expires after 30 minutes. By default. then include the Web CGI or Web Cartridge commands SHOWAUTH and AUTHYPE=S in the report URL. If you want users to authenticate every time they make a Web request.dat (Web Cartridge) or cgicmd.
542
Report Builder Reference
. their browser is sent an encrypted cookie that authenticates them to the secured Reports Server. When a cookie expires. If you want users to authenticate and remain authenticated until the cookie expires. You can use the REPORTS60 COOKIE_EXPIRE environment variable to change the expiration time of the authentication cookie. subsequent requests (i.AUTHID
Description AUTHID is the username and password used to authenticate users to a secured Reports Server.e. See your DBA to create new user profiles in WebDB.dat (Web CGI) file.

see "Automatic Logon".dat (Web CGI) file. see "Remote Logon". then include the Web CGI or Web Cartridge commands SHOWAUTH and AUTHTYPE=D in the report URL. For more information about the optional Net8 communication protocol.dat (Web Cartridge) or cgicmd. Net8 communication protocol to access a remote database. If you want users to log on to the database. For more information about automatic logon. Values The database connection string must be in one of the following forms and cannot exceed 512 bytes in length:
username[/password] username[/password][@database] [user[/password]]@ODBC:datasource[:database] or [user[/password]]@ODBC:* <$username>[/password] <$username>[/password][@database]
Report Builder Reference
543
. If you want users to log on every time they make a Web request. omit the USERID command from the report request. or ODBC datasource name (if accessing a non-Oracle datasource. or include the %D argument in the key mapping entry in the owscmd.. $username) and password with an optional database name.USERID
Description USERID is the ORACLE username or placeholder username (i.e.

tdf file)
The following PL/SQL library conversions can be performed using RWCON60:
n convert a library stored in the database into a . a warning is displayed.rep file is not created.rep file using Convert. Fonts are not mapped during the conversion.rep file. The following report conversions can be performed using RWCON60:
n convert a report stored in the database into a . n You try to create a .tdf file) n convert a report stored in a . but the conversion continues. If there are compile errors. .rex.rex file.rex file into a database report.RWCON60
Description RWCON60 enables you to convert one or more report definitions or PL/SQL libraries from one storage format to another. n You use a .pld file into a database library or a . n You use a report that was created on another platform as the Source report. If there are compile errors. .pll file into a database library or a . a warning is displayed. Program Compile All).pld file.pll file n convert a library stored in a . you must compile the report’s PL/SQL yourself (e. . . If there are compile errors.. or a template (. Provided that your conversion Destination is not a .pll file n convert a library stored in a .
544
Report Builder Reference
.rdf file into a ..rex file as the Source report. n Fonts are mapped when a report is opened by Report Builder and Reports Runtime. or a template (.rep.g.
where keyword=value is a valid command line argument.pld or . Convert will automatically compile the report’s PL/SQL as part of the conversion process.rdf file.rdf file.rex file. In all other situations. PL/SQL is automatically compiled under the following conditions. or a template (.rep or . or a database report.tdf file) n convert a report stored in a . Usage Notes
n In some cases. but the conversion continues.. an error message is displayed and the .
Syntax
rwconv60 [ [keyword=]value ] .

rdf file.pll files attached to the report before converting the . you should convert the . Objects in the body are ignored.
Report Builder Reference
545
.n When converting a report to a template. and the margin area are used in the template. only objects in the report’s header and trailer pages. n When converting reports that have attached libraries.

PLDFILE means that the source PL/SQL libraries are stored in files in ASCII format. Syntax
[STYPE=]{DATABASE|PLLDB|PLDFILE|PLLFILE|RDFFILE|REXFILE}
Values DATABASE means that the source report(s) are stored in ORACLE. PLLFILE means that the source PL/SQL libaries are stored in files containing source code and P-code.rdf).STYPE (RWCON60)
Description STYPE is the format of the report(s) or libraries to be converted.rex). RDFFILE means that the source report(s) are stored in one or more report definition files (files with an extension of . Default DATABASE
Report Builder Reference
547
. REXFILE means that the source report(s) are stored in one or more text files (files with an extension of . PLLDB means that the source PL/SQL libraries are stored in the database.

.dsmith. the userid is assumed to be the current user.qanda. For example. n The argument(s) for this keyword may be operating system-specific.dmast. . n You must have created the reports/libraries. or have been granted access to the ones you did not create.rdf..sname2. . Syntax
[SOURCE=]{sname|(sname1. For example:
(qanda.sal)
n If you are using user-owned Report Builder tables.rex.. .rep. RWCON60 requires that you specify a source report or library. qanda).e. R% would fetch all reports stored in the database that begin with R. n If you are converting reports/libraries stored in ORACLE and are using systemowned Report Builder tables.)}
Values Any valid report/library name or filename (e. A list of valid report/library names or filenames enclosed by parentheses with a comma separating the names (e. (qanda. n If you are converting from database to file and the database report/library name is too long to be a filename.g.g.SOURCE (RWCON60)
Description SOURCE is the report/library or list of reports/libraries to be converted.
548
Report Builder Reference
.test.dmast)). dmast)
n Wildcard characters are invalid for reports/libraries stored in files (i. with extensions of .pll). Report Builder prompts you to provide a filename of the correct length for your operating system.. . for example:
SOURCE=(sday. n A list of report/library names or filenames must be enclosed in parentheses with commas separating the names. reports/libraries from multiple users must be converted for each user individually. Usage Notes
n SQL wildcard characters (% and _) may be used for reports or libraries that are stored in the database. All reports that match will be converted. If no userid is prefixed to the report/library name. test.test..test. in order to convert them. you may list reports/libraries of other users.pld..dmast) (qanda.

rep).rdf). and the margin area are used in the template. PLLFILE means that the converted PL/SQL libaries will be stored in files containing source code and P-code.rex).rep file. n When converting a report to a template. an error message is displayed and the .tdf file). the source report’s PL/SQL is automatically compiled. If there are compile errors. Default REXFILE Usage Notes
n When you try to create a .DTYPE (RWCON60)
Description DTYPE is the format to which to convert the reports or libraries .rep file is not created. PLLDB means that the converted PL/SQL libraries will be stored in the database. only objects in the report’s header and trailer pages. REPFILE means that the converted reports will be stored in one or more binary runfiles (files with an extension of . TDFFILE means that the report will be converted to a template (. RDFFILE means that the converted reports will be stored in one or more report definition files (files with an extension of . To avoid this problem.
Report Builder Reference
549
. make sure you compile the source report’s PL/SQL using File Compile before you try to create a . REXFILE means that the converted reports will be stored in one or more text files (files with an extension of . Syntax
[DTYPE=]{DATABASE|PLLDB|PLDFILE|PLLFILE|RDFFILE|REPFILE|REXFILE|TDFFILE}
Values DATABASE means that the converted reports will be stored in ORACLE. Objects in the body are ignored.rep file using RWCON60. PLDFILE means that the converted PL/SQL libraries will be stored in files in ASCII format.

Syntax
[DEST=]{dname|(dname1.. RWCON60 uses the following default names:
n If DTYPE is DATABASE or PLLDB. the DEST is SOURCE with the .g. then DEST is SOURCE with the . n If DTYPE is RDFFILE. qanda)..pld extension. or the names of the files.)|pathname}
Values Any valid report/library name or filename (e. then DEST is expdat. n If DTYPE is REPFILE. A list of valid report/library names or filenames enclosed by parentheses with a comma separating the names (e..DEST (RWCON60)
Description DEST is the name(s) of the converted reports or libraries.rdf extension.dname2. if they are stored in the database. default names will be used after the destination names run out.g.
Usage Notes
n A list of report/library names or filenames must be enclosed in parentheses with commas separating the names. If you have fewer destination names than there are source names.pll file extension.test. n If DTYPE is PLLFILE. n If DTYPE is REXFILE.. then DEST is SOURCE. n The argument(s) for this keyword may be operating system-specific. dmast)
n If you have more destination names than there are source names. test.dmast)). Default If the DEST keyword is not specified. n If DTYPE is PLDFILE.rex. then DEST is SOURCE with the . the extra destination names are ignored. (qanda.rep extension.
550
Report Builder Reference
.dmast) (qanda. For example:
(qanda. then DEST is SOURCE with the .test..

For more information.
Report Builder Reference
551
. suppose that you specify RWRUN60 from the command line with COPIES equal to 1 and CMDFILE equal to RUNONE (a command file). In RUNONE. Only one copy of the report would be generated in this case. Syntax
[CMDFILE=]cmdfile
Values Any valid command file.CMDFILE (RWCON60)
Description CMDFILE is a file that contains arguments for the RWCON60 command. see "Command Line Syntax Rules". For example. n Values entered on the command line override values specified in command files. Usage Notes
n A command file may reference another command file. n The argument(s) for this keyword may be operating system-specific. n Command file syntax for RWCON60 arguments is identical to that used on the command line. COPIES is set to 2. This option enables you to convert a report/library without having to specify a large number of arguments each time you invoke RWCON60.

[LOGFILE=]logfile
Values Any valid filename.LOGFILE (RWCON60)
Description LOGFILE is the name of the file to which status and error output is sent.
552
Report Builder Reference
.log in the current directory. Default dfltrep.

OVERWRITE (RWCON60)
Description OVERWRITE specifies whether to overwrite existing files or database objects with the converted files or objects. Default NO
Report Builder Reference
553
. PROMPT means to prompt you before overwriting any existing or database objects. Syntax
[OVERWRITE=]{YES|NO|PROMPT}
Values YES means automatically overwrite any existing files or database objects of the same name. NO means not to convert reports if there are existing files or database objects of the same name and display a warning message.

The Convert dialog box is displayed and. Default NO
554
Report Builder Reference
. the conversion is performed. when you accept the dialog box. NO allows special terminal input and output. Syntax
[BATCH=]{YES|NO}
Values YES suppresses all terminal input and output.BATCH (RWCON60)
Description BATCH suppresses all terminal input and output. in order to convert reports/libraries without user intervention.

Default Blank
Report Builder Reference
555
. If left blank. If specified. INCH means that the converted reports will initially use inches as the unit of measurement. Syntax
[DUNIT=]{CENTIMETER|CHARACTER|INCH|POINT}
Values CENTIMETER means that the converted reports will initially use centimeters as the unit of measurement. the SOURCE report’s unit of measurement is used as the DEST report’s unit of measurement.DUNIT (RWCON60)
Description DUNIT is the destination unit of measurement to which the report should be converted. DUNIT must differ from the SOURCE report’s unit of measurement. POINT means that the converted reports will initially use points as the unit of measurement. CHARACTER means that the converted reports will initially use characters as the unit of measurement.

you can use a decimal to specify fractions (e.g.5 * 80)/80 x (11 * 20)/66 = 8. the bit-mapped page size would be: (8. 80 x 66 characters. 8.33. 8.5 x 3. If the report was designed for character mode and is being run or converted on bitmap.
556
Report Builder Reference
. if the character page size is 80 x 20. Usage Notes
n For non-character DUNITs.. the following formula is used to determine page size if none is specified: (default page size * character page size)/default character page size.PAGESIZE (RWCON60)
Description PAGESIZE is the size of a logical page for the converted reports in terms of destination unit of measurement (specified using the DUNIT keyword).5 x 11). For character mode.5 x 11 inches. For example. Default For bitmap. Syntax
[PAGESIZE=]width x height
Values Any valid value in the unit of measurement and of the form width x height.

FORMSIZE (RWCON60)
Description FORMSIZE is the size of the Runtime Parameter Form for the converted report in terms of destination unit of measurement (specified using the DUNIT keyword). Syntax
[FORMSIZE=]width x height

Values Any valid value in the unit of measurement and of the form width x height. Usage Notes

n For non-character DUNITs, you can use a decimal to specify fractions (e.g., 8.5 x 11).

Report Builder Reference

557

CUSTOMIZE (RWCON60)
Description CUSTOMIZE specifies an XML file or list of files that you want to apply to the reports listed in the SOURCE keyword. The XML file contains customizations (e.g., font changes or color changes) that change the report definition in some way. For more information, refer to the Publishing Reports manual. Syntax
[CUSTOMIZE=]filename.xml | (filename1.xml, filename2.xml, . . .)

Values A filename or list of filenames that contain a valid XML report definition, with path information prefixed to the filename(s) if necessary.

558

Report Builder Reference

RWMTS60
Description RWMTS60 is the Reports Multi-tier Server (hereafter the Reports Server) executable. To implement a multi-tiered architecture for running your reports, the Reports Server enables you to run reports on a remote application server. To start RWMTS60 from the command line, use RWCLI60. When used in conjunction with the Reports Web Cartridge or Reports Web CGI, the Reports Server also enables you to run reports from a Web browser using standard URL syntax. The server can be installed on Windows NT, Windows 95, or UNIX. It handles client requests to run reports by entering all requests into a job queue. When one of the server’s runtime engines becomes available, the next job in the queue is dispatched to run. As the number of jobs in the queue increases, the server can start more runtime engines until it reaches the maximum limit specified when the server process was started. Similarly, idle engines are shut down after having been idle for longer than a specified period of time. You can also use the server to run reports automatically. The scheduling command enables you to specify a time and frequency for the report. The server keeps track of a predefined maximum number of past jobs. Information on when the jobs are queued, started, and finished is kept, as well as the final status of the report. This information can be retrieved and reviewed on Windows from the Reports Queue Manager (RWRQM60) or via the API. The Reports Queue Manager may reside on the same machine as the Reports Server or on a client machine. On UNIX, you can use the Reports Queue Viewer (RWRQV60) to view the Reports Server’s queue.

Report Builder Reference

559

RWRQM60
Description RWRQM60 is the Reports Queue Manager executable (on the Windows platform). When you use the Reports Server executable (RWMTS60) to schedule running reports on a remote server, the Reports Queue Manager enables you to review when the jobs are queued, started, and finished, as well as the final status of the report. You can also manipulate the jobs and the server. The Reports Queue Manager may reside on the same machine as the Reports Server or on a client machine. On UNIX, you can use the Reports Queue Viewer (RWRQV60) to view the Reports Server’s queue.

560

Report Builder Reference

RWRQV60
Description RWRQV60 is the Reports Queue Viewer executable (on the UNIX platform). When you use the Reports Server executable (RWMTS60) to schedule running reports on a remote server, the Reports Queue Viewer enables you to view the Reports Server’s queue. On the command line, type RWRQV60 "?" for keyword help. On Windows, you can use the Reports Queue Manager (RWRQM60) to view and manipulate the Reports Server’s queue.

Report Builder Reference

561

RWOWS60
Description RWOWS60 is the Reports Web Cartridge that provides an easy connection between the Oracle Web Application Server and the Reports Server (RWMTS60). This connection enables a Web client to run reports on the Reports Server and see the report output on the client Web browser. Like other Web Cartridges, RWOWS60 is a dynamically-linked, or shared, library that is managed by a Web Request Broker, which is associated with a particular Oracle Web Application Server Listener. RWOWS60 is an alternative to the Reports Web CGI (RWCGI60) and has the same functionality, but it also has native integration with the Oracle Web Application Server.

562

Report Builder Reference

RWRBE60
Description RWRBE60 is the Reports Background Engine. The Reports Background Engine waits for any command lines to run reports. When it receives a command line, it places that report in its queue. Typically, the Reports Background Engine receives command lines from a form or graphic using the RUN_PRODUCT packaged procedure, or from a report using SRW.RUN_REPORT. Syntax:
rwrbe60

Usage Notes • •

n n

RWRBE60 was called R25SRV in earlier versions. You can also start the RWRBE60 executable by double-clicking it.

n On Windows, you can use RWISV60 to submit a report to the Reports Background Engine for execution. This is a more efficient method because it incurs less performance overhead than Reports Runtime. The command line arguments for RWISV60 are the same those for RWRUN60.
•

n RWRBE60 is only used to run reports locally. Use RWCLI60 to send reports to the Reports Server (RWMTS60).

n If you are running an .rep file, the PL/SQL is already compiled and will not be recompiled. If you are running an .rdf file, the PL/SQL is automatically recompiled if necessary (i.e., you didn’t compile and save the report from Report Builder, or the platform or version on which you are running the report is incompatible with the platform on which it was last compiled and saved). n There are two versions of RWRUN60. It is important to note that with either executable, you can run character-mode or bit-mapped reports. The only limiting factor is the output device (e.g., you could not run a bit-mapped report to the screen of a vt220). n The character-mode executable is for users who are running reports from character-mode machines (e.g., VT220). n The GUI executable is for users who are running reports from bit-mapped machines (e.g., a PC running Windows).

MODULE|REPORT (RWRUN60)
Description MODULE|REPORT is the name of the report to run. (REPORT is allowed for backward compatibility.) Syntax
[MODULE|REPORT=]runfile

Values Any valid runfile (i.e., a file with an extension of .rdf or .rep). If you do not enter a file extension, Reports Runtime searches first for a file with extension .rep, then extension .rdf, and then no extension. Reports Runtime will use its file path search order to find the file.

MODULE|REPORT Restrictions
n If you specify a runfile using MODULE|REPORT, the RWRUN60 window is not raised. (This behavior provides seamless entry into RWRUN60 from other applications.) If you do not specify a runfile using MODULE/REPORT and you specify BATCH=NO, the RWRUN60 window is opened, which enables you to run reports interactively. n If you run a character-mode report via bit-mapped RWRUN60, Reports Runtime displays a warning, then runs the report using a page size of 8.5" x 11" and a form size of 7" x 6".

Report Builder Reference

567

PARAMFORM (RWRUN60)
Description PARAMFORM specifies whether to display the Runtime Parameter Form when you execute a report. Syntax
[PARAMFORM=]{YES|NO}

Values YES means to display the Form. NO means to suppress the Form. Default YES Usage Notes PARAMFORM=YES is incompatible with BATCH=YES because it is not meaningful to have the Runtime Parameter Form appear in batch mode.

568

Report Builder Reference

This option enables you to run a report without having to specify a large number of arguments each time you invoke RWRUN60. n Values entered on the command line override values specified in command files.CMDFILE (RWRUN60)
Description CMDFILE is a file that contains arguments for the RWRUN60 command. suppose that you specify RWRUN60 from the command line with COPIES equal to 1 and CMDFILE equal to RUNONE (a command file). n Command file syntax for RWRUN60 arguments is identical to that used on the command line. COPIES is set to 2. n The argument(s) for this keyword may be operating system-specific. For example.
CMDFILE Restrictions
n A command file may reference another command file. In RUNONE. Only one copy of the report would be generated in this case.
Report Builder Reference
569
. Syntax
[CMDFILE=]cmdfile
Values Any valid command file.

(See your System Administrator for a compatible definition.
570
Report Builder Reference
.) Usage Notes
n The argument(s) for this keyword may be case sensitive. This keyword is only used in character mode. depending on your operating system. Default Installation dependent.TERM (RWRUN60)
Description TERM is the type of terminal on which you are using RWRUN60. TERM is useful for the Runtime Parameter Form and Runtime Previewer only. Syntax
[TERM=]termtype
Values Any valid terminal type.

Generally. the larger the array size.999. see the Oracle8 Server Administrator’s Guide. For details about the ORACLE array processing. Default The default array size is 10K. This means that Reports Runtime can use this number of kilobytes of memory per query in your report.ARRAYSIZE (RWRUN60)
Description ARRAYSIZE is the size (in kilobytes) for use with ORACLE array processing. the faster the report will run.
Report Builder Reference
571
. Syntax
[ARRAYSIZE=]n
Values A number from 1 through 9.

This value is valid only when the BATCH=NO. or MAIL. (If DESTYPE is something other than PRINTER. Font aliasing is not performed for Screen. Sends the output to your operating system’s default output device. This value is valid only when BATCH=YES. Usage Notes
n
If you set DESTYPE to PRINTER.
Default Taken from the Initial Value property of the DESTYPE parameter.DESTYPE (RWRUN60)
Description DESTYPE is the type of device that will receive the report output. or MAIL. file. The Previewer will use DESNAME to determine which printer’s fonts to use to display the output. After you accept the Print Job dialog box. Preview causes the output to be formatted as PostScript output. the report is executed and the output is sent to the printer (specified in File Choose Printer). or mail ID.
572
Report Builder Reference
. FILE. the Print Job dialog box will appear after you accept the Runtime Parameter Form. Routes the output to the Previewer for interactive viewing. You can send mail to any mail system that is MAPI compliant or has the service provider driver installed. Font aliasing is performed for Preview.) The appearance of the dialog box varies between operating systems. Saves the output to a file named in DESNAME (the next keyword discussed). unless it is suppressed. However. The report is sent as an attached file. then the report is executed after you accept the Runtime Parameter Form. Syntax
[DESTYPE=]{SCREEN|FILE|PRINTER|PREVIEW|SYSOUT|MAIL}
Values SCREEN
FILE PRINTER PREVIEW
SYSOUT
MAIL
Routes the output to the Previewer for interactive viewing. Sends the output to the mail users specified in DESNAME. Routes the output to the printer named in DESNAME (the next keyword discussed). FILE.

Report Builder Reference
573
. Some DESTYPE values are not supported on some operating systems. this parameter may be overridden by your operating system.n n
In some cases.

depending on your operating system. To send the report output via email. For printer names.lis at runtime.DESNAME (RWRUN60)
Description DESNAME is the name of the file. (name. Reports Runtime uses DESNAME to determine which printer’s fonts to use to display the output. .g. . name. it defaults to reportname. you can optionally specify a port.LPT1: DESNAME=printer. this parameter may be overridden by your operating system.FILE:
Default Taken from the Initial Value property of the DESNAME parameter. You can specify multiple usernames by enclosing the names in parentheses and separating them by commas (e. n The argument(s) for this keyword may be case sensitive. specify the email ID as you do in your email application (any MAPI-compliant application on Windows or your native mail application on UNIX).
574
Report Builder Reference
. n In some cases. Usage Notes
n This keyword is ignored if DESTYPE is SCREEN or SYSOUT. n If DESTYPE is PREVIEW.name)). . printer. If DESTYPE=FILE and DESNAME is an empty string. or email ID (or distribution list) to which the report output will be sent.. For example:
DESNAME=printer. printer name. Syntax
[DESNAME=]desname
Values Any valid filename. or email ID not to exceed 1K in length.

decland. XML Means that the report output will be an XML document. Netscape 2. such as Microsoft Excel.0 compliant browser (e. Syntax
[DESFORMAT=]desformat
Values Any valid destination format not to exceed 1K in length. decwide. RTF Means that the report output will be sent to a file that can be read by standard word processors (such as Microsoft Word). HTMLCSS Means that the report output sent to a file will include style sheet extensions that can be read by an HTML 3. Examples of valid values for this keyword are hpl.2). etc.
Report Builder Reference
575
. This report can be opened and read in an XML-supporting browser. saved as a separate file with the . dec180. HTML Means that the report output will be sent to a file that can be read by an HTML 3. In addition. dec. wide. you must have a printer configured for the machine on which you are running the report. or your choice of XML viewing application.g. DELIMITED Means that the report output will be sent to a file that can be read by standard spreadsheet utilities. dflt. In character-mode environments. you must choose View Page Layout to view all the graphics and objects in your report. The drivers for the currently selected printer is used to produce the output. it specifies the characteristics of the printer named in DESNAME.0 compliant browser that supports cascading style sheets. PDF output is based upon the currently configured printer for your system... DESFORMAT specifies the printer driver to be used when DESTYPE is FILE. Note that you must also specify a DELIMITER. HTMLCSSIE Means that the report output sent to a file will include style sheet extensions that can be read by Microsoft Internet Explorer 3.x. hplwide. Ask your System Administrator for a list of valid destination formats. Note that when you open the file in MS Word.DESFORMAT (RWRUN60)
Description In bit-mapped environments.XML extension. Report Builder supports the following destination formats: PDF Means that the report output will be sent to a file that can be read by a PDF viewer.

if DESFORMAT is blank or dflt. n The value(s) for this keyword may be case sensitive. If nothing has been selected in Choose Printer. For bit-mapped Reports Runtime. depending on your operating system. Usage Notes
n This keyword is ignored if DESTYPE is SCREEN or SYSOUT.Default Taken from the Initial Value property of the DESFORMAT parameter.
576
Report Builder Reference
. then Postscript is used by default. then the current printer (specified in File Choose Printer) is used.

Syntax
[COPIES=]n
Values Any valid integer from 1 through 9. n If COPIES is left blank on the Runtime Parameter Form. Default Taken from the Initial Value property of the COPIES parameter. it defaults to one.
Report Builder Reference
577
. Usage Notes
n This keyword is ignored if DESTYPE is not Printer.999.COPIES (RWRUN60)
Description COPIES specifies the number of copies of the report output to print.

n If the location of the temporary file directory does not have sufficient available disk space. Values YES means to cache the LOB in the temporary file directory. may decrease performance. however.CACHELOB (RWRUN60)
Description CACHELOB specifies whether to cache retrieved Oracle8 large object(s) in the temporary file directory (specified by REPORTS60_TMP).
578
Report Builder Reference
. Default YES Usage Notes
n You can only set this option on the command line. Setting the value to NO. NO means to not cache the LOB in the temporary file directory. it is preferable to set this value to NO. as the LOB may need to be fetched from the server multiple times.

Report Builder Reference
579
. You can also set a default of up to four characters in the Initial Value field of the Parameter property sheet for the CURRENCY parameter. Usage Notes
n A CURRENCY value entered on the Runtime Parameter Form will override any CURRENCY value entered on the command line.CURRENCY (RWRUN60)
Description CURRENCY is the currency character to be used in number formats. Default The default for ORACLE is determined by the ORACLE National Language Support facilities. Syntax
[CURRENCY=]currency_symbol
Values Any valid alphanumeric string not to exceed 1K in length.

Syntax
[THOUSANDS=]thousands_symbol
Values Any valid alphanumeric character. You can also set a default in the Initial Value property of the THOUSANDS parameter." as the THOUSANDS value." is returned.
580
Report Builder Reference
. if you define ". Default The default for ORACLE is determined by the ORACLE National Language Support facilities. For example. ". Usage Notes
n A THOUSANDS value entered on the Runtime Parameter Form will override any THOUSANDS value entered on the command line.THOUSANDS (RWRUN60)
Description THOUSANDS is the thousands character to be used in number formats. n The alphanumeric character defined as the THOUSANDS value is the actual value that is returned.

” as the DECIMAL value. “. Syntax
[DECIMAL=]decimal_symbol
Values Any valid alphanumeric character. Usage Notes
n A DECIMAL value entered on the Runtime Parameter Form will override any DECIMAL value entered on the command line.DECIMAL (RWRUN60)
Description DECIMAL is the decimal character to be used in number formats.” is returned. You can also set a default in the Initial Value property for the DECIMAL parameter.
Report Builder Reference
581
. n The alphanumeric character defined as the DECIMAL value is actual value that is returned. For example. if you define “. Default The default for ORACLE is determined by the ORACLE National Language Support facilities.

NO means do not provide read consistency.
582
Report Builder Reference
. Default NO Usage Notes
n READONLY is only useful for reports using multiple queries. for single query reports. Syntax
[READONLY=]{YES|NO}
Values YES requests read consistency. When accessing data from ORACLE. without locking.READONLY (RWRUN60)
Description READONLY requests read consistency across multiple queries in a report. because ORACLE automatically provides read consistency. read consistency is accomplished by a SET TRANSACTION READ ONLY statement (refer to your Oracle8 Server SQL Language Reference Manual for more information on SET TRANSACTION READ ONLY).

Report Builder Reference
583
. This keyword is only used in character mode. Default dfltrep.log in the current directory. If the specified file already exists.LOGFILE (RWRUN60)
Description LOGFILE is the name of the file to which File Print Screen output is sent. Syntax
[LOGFILE=]logfile
Values Any valid filename. output will be appended to it.

584
Report Builder Reference
. Default 640K Usage Notes
n If this setting is changed in the middle of your session.BUFFERS (RWRUN60)
Description BUFFERS is the size of the virtual memory cache in kilobytes. For some operating systems. but not so much that you are using too much of your system’s resources.999. Syntax
[BUFFERS=]n
Values A number from 1 through 9. the upper limit may be lower. the change does not take effect until the next time the report is run. You should tune this setting to ensure that you have enough space to run your reports.

in order to run reports without user intervention.BATCH (RWRUN60)
Description BATCH suppresses all terminal input and output. BATCH=YES enables you to run the report without bringing up the RWRUN60 interface. To run reports in the background. bit-mapped reports cannot be run. Syntax
[BATCH=]{YES|NO}
Values YES suppresses all terminal input and output.) n When BATCH=YES. NO allows special terminal input and output. For more information on SYSOUT. Default NO Usage Notes
n If BATCH=YES. see DESNAME. error messages are sent to SYSOUT. n If BATCH=YES. you cannot run a character-mode report. PARAMFORM=YES is invalid because it is not meaningful to have the Runtime Parameter Form appear in batch mode. n When BATCH=NO and you are using the character-mode RWRUN60. (It is not possible to run a bit-mapped report to the screen of a character-mode device. MODE=BITMAP.
Report Builder Reference
585
. and you are using the character-mode RWRUN60. see BACKGROUND.

where page width and page height are zero or more. the maximum width/height is 512 inches.
586
Report Builder Reference
. Default For bitmap.5 * 80)/80 x (11 * 20)/66 = 8.33. For picas.. its value overrides the page dimensions of the report definition. if a frame in a report expands to a size larger than the page dimensions. For example. For inches. For character mode. 80 x 66 characters. the sheet of paper a printer takes may be 8. If the report was designed for character mode and is being run or converted on bitmap.e.5 x 11 inches. For example. the following formula is used to determine page size if none is specified: (default page size * character page size)/default character page size.5 x 3. but the printer might only be able to print on an area of 8 x 10. you can either increase the printable area for the printer (if your operating system allows it) or you can set the page width x page height to be the size of the printable area of the page. clipping may occur in your report output. the report will not run.5 x 11 inches. If you define a page width x page height in Reports Runtime that is bigger than the printable area your printer allows. For example. The maximum width/height depends upon the unit of measurement. n If this keyword is used. if the character page size is 80 x 20. For centimeters. the size of the page that the printer outputs).864 picas.PAGESIZE (RWRUN60)
Description PAGESIZE is the dimensions of the physical page (i. the bit-mapped page size would be: (8. it is 36.5 inches. To avoid clipping. Usage Notes
n On some printers the printable area of the physical page is restricted. 8. it is 1312 centimeters. n A PAGESIZE value entered on the Runtime Parameter Form will override any PAGESIZE value entered on the command line. Note that the page must be large enough to contain the report. Syntax
[PAGESIZE=]width x height
Values Any valid page dimensions of the form: page width x page height.

Report Builder Reference
587
. n Time is the amount of time spent in Reports Runtime.DO_SQL. PROFILE calculates the following statistics:
n TOTAL ELAPSED TIME is the amount of time that passes between when you issue RWRUN60 and when it finishes running the report. Reports Runtime calculates statistics on the elapsed and CPU time spent running the report. and fetch the data. the Reports Runtime time includes the database time because the database is included in Reports Runtime’s process. Syntax
[PROFILE=]profiler_file
Values Any valid filename in the current directory. n ORACLE Time is the amount of time spent in the database and is composed of the following: n UPI is the amount of time spent to do such things as connect to the database. TOTAL ELAPSED TIME is the sum of Reports Runtime Time and ORACLE Time. parse the SQL.
Note: For some operating systems. n SQL is the amount of time spent performing SRW.PROFILE (RWRUN60)
Description PROFILE is the name of a file in which you want to store performance statistics on report execution. If you specify a filename. n TOTAL CPU Time used by process is the CPU time spent running the report.

n layout objects with page-dependent references that do not have fixed sizing. NO means do not perform extra runtime error checking. This can lead to objects overwriting other objects in the output. n bind variables referenced at the wrong frequency in PL/SQL. Syntax
[RUNDEBUG=]{YES|NO}
Values YES means perform extra runtime error checking. Default NO
588
Report Builder Reference
. RUNDEBUG checks for things that are not errors but might result in undesirable output.RUNDEBUG (RWRUN60)
Description RUNDEBUG is whether you want extra runtime checking for logical errors in the report. n the report is character mode or bitmap and the environment is the opposite. RUNDEBUG checks for the following:
n frames or repeating frames that overlap but do not enclose another object. Reports Runtime will make such objects fixed in size regardless of the Vertical Elasticity and Horizontal Elasticity property settings.

Oracle Forms) with no USERID provided. ROLLBACK means perform a ROLLBACK when the report is done. For more information.. Syntax
[ONSUCCESS=]{COMMIT|ROLLBACK|NOACTION}
Values COMMIT means perform a COMMIT when the report is done. Usage Notes
n The COMMIT or ROLLBACK for ONSUCCESS is performed after the After Report trigger fires.
Report Builder Reference
589
.ONSUCCESS (RWRUN60)
Description ONSUCCESS is whether you want a COMMIT or ROLLBACK performed when the report is finished executing. NOACTION.g. if called from an external source (e. see READONLY. Default COMMIT. if a USERID is provided. NOACTION means do nothing when the report is done. Other COMMITs and ROLLBACKs can occur prior to this one.

Default ROLLBACK. For more information. NOACTION. if a USERID is provided.. if called from an external source (e.ONFAILURE (RWRUN60)
Description ONFAILURE is whether you want a COMMIT or ROLLBACK performed if an error occurs and the report fails to complete. Syntax
[ONFAILURE=]{COMMIT|ROLLBACK|NOACTION}
Values COMMIT means perform a COMMIT if the report fails. Usage Notes
n The COMMIT or ROLLBACK for ONFAILURE is performed after the report fails. Other COMMITs and ROLLBACKs can occur prior to this one.g. Form Builder) with no USERID provided. see READONLY. NOACTION means do nothing if the report fails. ROLLBACK means perform a ROLLBACK if the report fails.
590
Report Builder Reference
.

Since KEYIN is used to execute a keystroke file. KEYIN is used to run the keystroke files created with KEYOUT.KEYIN (RWRUN60)
Description KEYIN is the name of a keystroke file that you want to execute at runtime. it is only relevant when runnning in a character-mode environment.
Report Builder Reference
591
. Syntax
[KEYIN=]keyin_file
Values Any valid key filename in the current directory.

Since KEYOUT is used to create a keystroke file.KEYOUT (RWRUN60)
Description KEYOUT is the name of a keystroke file in which you want Reports Runtime to record all of your keystrokes. it is only relevant when running reports in a character-mode environment. KEYOUT and KEYIN are useful when you have certain keystrokes that you want to do each time you run a report.
592
Report Builder Reference
. They are also useful for debugging purposes. Syntax
[KEYOUT=]keyout_file
Values Any valid filename. You can then use KEYIN to execute the keystroke file.

Syntax
[ERRFILE=]error_file
Values Any valid filename.ERRFILE (RWRUN60)
Description ERRFILE is the name of a file in which you want Reports Runtime to store all error messages that are issued during the execution of your report.
Report Builder Reference
593
.

Syntax
[LONGCHUNK=]n
Values A number from 1 through 9. Default 10K
594
Report Builder Reference
.LONGCHUNK (RWRUN60)
Description LONGCHUNK is the size (in kilobytes) of the increments in which Reports Runtime retrieves a LONG column value. LONGCHUNK applies only to Oracle7 and Oracle8. the upper limit may be lower. you may want to retrieve it in increments rather than all at once because of memory size restrictions. When retrieving a LONG value.999. For some operating systems.

Syntax
[ORIENTATION=]{DEFAULT|LANDSCAPE|PORTRAIT}
Values DEFAULT means use the current printer setting for orientation.
Report Builder Reference
595
. LANDSCAPE PORTRAIT Default DEFAULT Usage Notes
n If ORIENTATION=LANDSCAPE for a character-mode report. you must ensure that your printer definition file contains a landscape clause.ORIENTATION (RWRUN60)
Description ORIENTATION controls the direction in which the pages of the report will print.

Syntax
[BACKGROUND=]{YES|NO}
Values YES or NO Default NO Usage Notes
n On Windows. you can use RWRBE60 to submit a report to the Reports Background Engine for execution. or RWBLD60. though. After Form. When the report is actually executed. BACKGROUND=YES is not supported for BATCH=YES. The command line arguments for RWRBE60 are the same as the ones for RWRUN60. On Windows. it will establish its own database connection. If you are using SRW. and Validation triggers before the report runs. however.. specifying BACKGROUND=YES means that the report will go into the Reports Background Engine’s queue. DESTYPE=SCREEN or PREVIEW. This is a more efficient method because it incurs less performance overhead than Reports Runtime.e. When running in this way. these triggers will share the parent process' database connection.RUN_REPORT).
596
Report Builder Reference
. n If you run a report from Reports Runtime (i. When BACKGROUND is YES. you should commit database changes you make in the Before Form. n On the command line. another process is spawned. not the command line or SRW.BACKGROUND (RWRUN60)
Description BACKGROUND specifies whether the report should be run in the background. BACKGROUND=YES with BATCH=YES is supported.RUN_REPORT. This option is useful when you want to work on something else in the foreground while the report runs.

g. For example. you could invoke character-mode RWRUN60 and run the report with MODE=BITMAP. if you want to send a report to a Postscript printer from a terminal (e. a vt220). On Windows..MODE (RWRUN60)
Description MODE specifies whether to run the report in character mode or bitmap. This enables you to run a character-mode report from bit-mapped Reports Runtime or vice versa. specifying MODE=CHARACTER means that the Reports Runtime ASCII driver will be used to produce editable ASCII output. CHARACTER Default DEFAULT
Report Builder Reference
597
. Syntax
[MODE=]{BITMAP|CHARACTER|DEFAULT}
Values BITMAP DEFAULT means to run the report in the mode of the current executable being used.

598
Report Builder Reference
. such as RWRUN60. regardless of PRINTJOB. the Print Job dialog box will not appear.PRINTJOB (RWRUN60)
Description PRINTJOB specifies whether the Print Job dialog box should be displayed before running a report. one executable. such as RWBLD60). regardless of PRINTJOB. Syntax
[PRINTJOB=]{YES|NO}
Values YES or NO Default YES Usage Notes
n When a report is run as a spawned process (i. is called from within another executable. n When DESTYPE=MAIL.. the Print Job dialog box will not appear.e.

n If you specify LOGFILE or ERRFILE as well as TRACEFILE.dat Usage Notes
n Trace information can only be generated when running a . Syntax
[TRACEFILE=]tracefile
Values Any valid filename. You cannot specify logging when running a . Default trace. in the following case.log because it is the last file specified in the RWRUN60 command.rep file.log LOGFILE=mylog.
rwrun60 MODULE=order_entry USERID=scott/tiger TRACEFILE=trace.rdf file. all of the trace information will be placed in the most recently specified file. For example.TRACEFILE (RWRUN60)
Description TRACEFILE is the name of the file in which Reports Runtime logs trace information.log
Report Builder Reference
599
. all of the specified trace information would be placed in err.log ERRFILE=err.

rep file. Syntax
[TRACEMODE=]{TRACE_APPEND|TRACE_REPLACE}
Values TRACE_APPEND adds the new information to the end of the file.
600
Report Builder Reference
. You cannot specify logging when running a . Default TRACE_APPEND Usage Notes
n Trace information can only be generated when running a . TRACE_REPLACE overwrites the file.TRACEMODE (RWRUN60)
Description TRACEMODE indicates whether Reports Runtime should add the trace information to the file or overwrite the entire file.rdf file.

Syntax
[TRACEOPTS=]{TRACE_ERR|TRACE_PRF|TRACE_APP|TRACE_PLS| TRACE_SQL|TRACE_TMS|TRACE_DST|TRACE_ALL|(opt1. TRACE_OPTS=(TRACE_APP.)}
Values A list of options in parentheses means you want all of the enlcosed options to be used. TRACE_PRF) means you want TRACE_APP and TRACE_PRF applied. TRACE_APP means log trace information on all the report objects in the trace file. TRACE_PRF means log performance statistics in the trace file. . TRACE_ALL means log all possible trace information in the trace file.TRACEOPTS (RWRUN60)
Description TRACEOPTS indicates the tracing information that you want to be logged in the trace file. opt2. You can use this information to determine which section was sent to which destination. Default TRACE_ALL Usage Notes
n Trace information can only be generated when running a . TRACE_ERR means list error messages and warnings in the trace file. TRACE_PLS means log trace information on all the PL/SQL objects in the trace file.rdf file.. TRACE_SQL means log trace information on all the SQL in the trace file.
Report Builder Reference
601
. For example. You cannot specify logging when running a . TRACE_TMS means enter a timestamp for each entry in the trace file.. TRACE_DST means list distribution lists in the trace file.rep file.

Syntax
[NONBLOCKSQL=]{YES|NO}
Values YES means that other programs can execute while data is being fetched. Default YES
Report Builder Reference
603
.NONBLOCKSQL (RWRUN60)
Description NONBLOCKSQL specifies whether to allow other programs to execute while Reports Runtime is fetching data from the database. NO means that other programs cannot execute while data is being fetched.

604
Report Builder Reference
. Syntax
[ROLE=]rolename/[rolepassword]
Values A valid role and (optionally) a role password.ROLE (RWRUN60)
Description ROLE specifies the database role to be checked for the report at runtime. ROLE is useful for giving you the ability to run reports that query database tables to which you would not normally have access privileges.

Use this keyword when there are blank pages in your report output that you do not want to print. Syntax
[BLANKPAGES=]{YES|NO}
Values YES means print all blank pages NO means do not print blank pages Default
Report Builder Reference
605
.BLANKPAGES (RWRUN60)
Description BLANKPAGES specifies whether to suppress blank pages when you print a report.

DISABLENEW (RWRUN60)
Description DISABLENEW specifies whether to disable the View New Previewer menu to prevent the ability to display a new instance of the Runtime Previewer. Syntax [DISABLENEW=]{YES|NO} Values YES or NO Default NO
610
Report Builder Reference
.

you must specify DISTRIBUTE=YES on the command line.DST file that defines a report or report section distribution.DST
Values The name of a .DST file that defines the distribution for the current run of the report.
Report Builder Reference
611
. Syntax
[DESTINATION=]filename. Usage Notes
n
To enable the DESTINATION keyword.DESTINATION (RWRUN60)
Description The DESTINATION keyword allows you to specify the name of a .

NO means to ignore the distribution list and output the report as specified by the DESNAME and DESFORMAT parameters. Syntax
[DISTRIBUTE=]{YES|NO}
Values YES means to distribute the report to the distribution list.
612
Report Builder Reference
.DST file. This is fundamentally a debug mode to allow running a report set up for distribution without actually executing the distribution. you must specify DISTRIBUTE=YES. Default NO Usage Notes
n
To enable the DESTINATION keyword. as specified by the distribution list defined in the report distribution definition or a .DISTRIBUTE (RWRUN60)
Description DISTRIBUTE enables or disables distributing the report output to multiple destinations.

Syntax [DELIMITER=]value Values Any alphanumeric character or string of alphanumeric characters. such as: . means a comma separates each cell .DELIMITER (RWRUN60)
Description DELIMITER specifies the character(s) to use to separate the cells in your report output. such as: \t means a tab separates each cell \n means a new line separates each cell Default Tab Usage Notes This argument can only be used if you’ve specified DESFORMAT=DELIMITED.
Report Builder Reference
613
. means a period separates each cell You can also use any of these four reserved values: tab means a tab separates each cell space means a space separates each cell return means a new line separates each cell none means no delimiter is used You can also use escape sequences based on the ASCII character set.

such as: \t means a tab displays on each side of the cell \n means a new line displays on each side of the cell Default None Usage Notes
n This argument can only be used if you’ve specified DESFORMAT=DELIMITED. Syntax [CELLWRAPPER=]value Values Any alphanumeric character or string of alphanumeric characters. “ means a double quotation mark displays on each side of the cell ‘ means a single quotation mark displays on each side of the cell You can also use any of these four reserved values: tab means a tab displays on each side of the cell space means a single space displays on each side of the cell return means a new line displays on each side of the cell none means no cell wrapper is used You can also use escape sequences based on the ASCII character set.
614
Report Builder Reference
.CELLWRAPPER (RWRUN60)
Description CELLWRAPPER specifies the character(s) that displays around the delimited cells in your report output. n The cell wrapper is different from the actual delimiter .

Default NO
Report Builder Reference
617
. NO means to output the report without page streaming.PAGESTREAM (RWRUN60)
Description PAGESTREAM enables or disables page streaming for the report when formatted as HTML or HTMLCSS output. PL/SQL in a Before Report trigger (SRW.SET_PAGE_NAVIGATION_HTML).
[PAGESTREAM=]{YES|NO}
Syntax Values YES means to stream the pages. using the navigation controls set by the report developer using either of the following:
n n
the Page Navigation Control Type and Page Navigation Control Value properties in the Report Property Palette.

g. st Server Type 1: Express Server ct Connection 0: Express connection
Domain User
618
Report Builder Reference
.
ncacn_ip_tcp:olap2pc/sl=x/st=x/ct=x/sv=x /). -1. The server value contains four parameters that correspond to settings that are made in the Oracle Express Connection Editor and stored in connection (.xcf) files. All four parameters are required and can be specified in any order. Syntax
EXPRESS_SERVER="server=[server]/domain=[domain]/ user=[userid]/password=[passwd]"
Values A valid connect string enclosed in double quotes (") where server is the Express server string (e. See the Express Connection Editor Help system for information on these settings. The following table describes the parameters and their settings.
is the Express Server domain.EXPRESS_SERVER (RWRUN60)
EXPRESS_SERVER specifies the Express Server to which you want to connect. Unix systems use only the settings 0. is the userid to log into the Express Server. and -2. Parameter Description Setting sl Server Login -2: Host (Domain Login) -1: Host (Server Login) 0: No authentication required 1: Host (Domain Login) and Connect security 2: Host (Domain Login) and Call security 3: Host (Domain Login) and Packet security 4: Host (Domain Login) and Integrity security 5: Host (Domain Login) and Privacy security Notes: Windows NT uses all the settings.. Password is the password for the userid.

the command line should be as follows:
EXPRESS_SERVER="server=ncacn_ip_tcp:olap2-pc/sl=0/st=1/ ct=0/sv=1/ domain=tools//reports"
n You can use single quotes within the string. you must use another forward slash as an escape character.rdf destype=file desname=exp1. if the userid is John Smith) because the entire string is inside of quotes.html desformat=html batch=yes
Report Builder Reference
619
. if the domain were tools/reports. password.rdf destype=file desname=exp1.html desformat=html batch=yes
EXPRESS_SERVER without userid.g. For example.. password. n If a forward slash (/) is required in the string.2 or greater
n You can have spaces in the string if necessary (e.
EXPRESS_SERVER with userid. and domain (RWRUN60) example
rwrun60 userid=scott/tiger@nt805 express_server="server=ncacn_ip_tcp:olap2-pc/sl=1/st=1/ct=0/ sv=1/ user=orbuild/domain=tools/password=buildme/" report=exp.sv Usage Notes
Type Server Version 1: Express 6. It is not treated specially because it is enclosed within double quotes. and domain (RWRUN60) example
rwrun60 userid=scott/tiger@nt805 express_server="server=ncacn_ip_tcp:olap2-pc/sl=0/st=1/ct=0/ sv=1/" report=exp.

Usage Notes Typically.. For more information. The XML file contains customizations (e.. filename2.XML. with path information prefixed to the filenames if necessary. refer to the Publishing Reports manual.)
Values The names of files that contain valid XML report definitions.xml.CUSTOMIZE (RWRUN60)
Description CUSTOMIZE specifies an XML file or list of files that you want to apply to the report selected in the MODULE or REPORT keyword.xml. font changes or color changes) that change the report definition in some way.g. the file extension of an XML report definition is . but it does not have to be when it is used with the CUSTOMIZE keyword.xml|(filename1.
620
Report Builder Reference
. Syntax
[CUSTOMIZE=]filename. ..

SAVE_RDF (RWRUN60)
Description SAVE_RDF specifies a file to which you want to save the report selected in the MODULE or REPORT keyword combined with the XML customization file(s) selected in the CUSTOMIZE keyword. Syntax
[SAVE_RDF=]filename.
Report Builder Reference
621
. This argument is most useful when you have an .RDF file to which you are applying an XML file via the CUSTOMIZE keyword and want to save the combination of the two to a new .rdf
Values Any valid filename. For more information. refer to the Publishing Reports manual.RDF file.

Input Mask. The value you specify is used for that parameter’s value. n Values of arguments may be in single or double quotes.<param> (RWRUN60)
Description <param> is a parameter that is part of the report’s definition. n If you do not specify runfile(s) using the REPORT keyword. the PARAM value is not parsed.. the PARAM values will be validated using the settings specified for each parameter (e.g. because the parameters may refer to those that have not yet been defined. Default Taken from the Initial Value property of the parameter.
622
Report Builder Reference
. n If you specify runfile(s) using the REPORT keyword. or validated. The effect of single or double quotes is operating-system specific. Usage Notes
n You can override the default value on the Runtime Parameter Form. Validation Trigger) in the report(s). Syntax
<param>=value
Values Any valid value for that parameter.