Tài liệu Oracle Reports Reference ppt

Oracle
®
Reports
Reference
RELEASE 6.0
April, 1999
Enabling the Information Age
™
Through Network Computing
Report Builder Reference
ii
Oracle
®
Reports Reference Release 6.0
The part number for this volume is A66243-02
Copyright © 1999, Oracle Corporation. All rights reserved.
Contributors: Carol Menzigian, Frank Rovitto, Ingrid Snedecor, Vanessa Wang
The programs are not intended for use in any nuclear, aviation, mass transit, medical, or other
inherently dangerous applications. It shall be licensee’s responsibility to take all appropriate fail-
safe, back up, redundancy and other measures to ensure the safe use of such applications if the
Programs are used for such purposes, and Oracle disclaims liability for any damages caused by
such use of the Programs.
This Program contains proprietary information of Oracle Corporation; it is provided under a license
agreement containing restrictions on use and disclosure and is also protected by copyright, patent and
other intellectual property law. Reverse engineering of the software is prohibited.
The information contained in this document is subject to change without notice. If you find any
problems in the documentation, please report them to us in writing. Oracle Corporation does not warrant
that this document is error free. No part of this document may be reproduced or transmitted in any form
or by any means, electronic or mechanical, for any purpose, without the express written permission of
Oracle Corporation
If this Program is delivered to a U.S. Government Agency of the Department of Defense, then it is

delivered with Restricted Rights and the following legend is applicable:
Restricted Rights Legend Programs delivered subject to the DOD FAR Supplement are "commercial
computer software" and use, duplication and disclosure of the Programs shall be subject to the licensing
restrictions set forth in the applicable Oracle license agreement. Otherwise, Programs delivered subject
to the Federal Acquisition Regulations are "restricted computer software" and use, duplication and
disclosure of the Programs shall be subject to the restrictions in FAR 52.227-14, Rights in Data
General, including Alternate III (June 1987). Oracle Corporation, 500 Oracle Parkway, Redwood City,
CA 94065.
Oracle is a registered trademark, and Oracle Developer, Express, Oracle Browser, Oracle Forms, Oracle
Graphics, Oracle Installer, Oracle Reports, Oracle7, Oracle8, Oracle Web Application Server, Personal
Oracle, Personal Oracle Lite, and PL/SQL are trademarks or registered trademarks of Oracle
Corporation. Portions copyright @ Blue Sky Software Corporation. All rights reserved. All other
company or product names mentioned are used for identification purposes only and may be trademarks
of their respective owners.
Report Builder Reference
iii
Table of Contents
BUILT-INS 1
B
UILT-IN PACKAGES 2
SRW.SET_ATTR
ATTRIBUTES 3
ACTION 4
AFTCODE 5
AFTFORM_ESCAPE 6
AFTPAGE_ESCAPE 7
AFTREPORT_ESCAPE 8
BBCOLOR 9
BEFCODE 10
BEFFORM_ESCAPE 11

BEFPAGE_ESCAPE 12
BEFREPORT_ESCAPE 13
BFCOLOR 15
BOOKMARK 16
BORDERWIDTH 18
BORDPATT 19
FACE 20
FBCOLOR 21
FFCOLOR 22
FILLPATT 23
FORMATMASK 24
GCOLOR 25
GSPACING 26
HJUST 27
HYPERLINK 28
LINKTAG 30
PRINTER_INTRAY 31
STYLE 32
SZ 33
TEXT 34
WEIGHT 35
T
HE REPORT BUILDER PL/SQL PACKAGE (SRW) 36
SRW.BREAK 37
SRW.CONTEXT_FAILURE 38
SRW.DO_SQL 39
SRW.DO_SQL_FAILURE 41
SRW.FILE_ESCAPE 42
SRW.GETERR_RUN 43
SRW.GET_PAGE_NUM 44

SRW.TEXT_ESCAPE 45
S
ET ATTRIBUTES PROCEDURES 46
SRW.SET_AFTER_FORM_HTML 47
SRW.SET_AFTER_PAGE_HTML 48
SRW.SET_AFTER_PRINTING_CODE 49
SRW.SET_AFTER_REPORT_HTML 50
SRW.SET_BACKGROUND_BORDER_COLOR 51
SRW.SET_BACKGROUND_FILL_COLOR 52
SRW.SET_BEFORE_FORM_HTML 53
SRW.SET_BEFORE_PAGE_HTML 54
SRW.SET_BEFORE_PRINTING_CODE 55
Report Builder Reference
iv
SRW.SET_BEFORE_REPORT_HTML 56
SRW.SET_BOOKMARK 57
SRW.SET_BORDER_PATTERN 59
SRW.SET_BORDER_WIDTH 60
SRW.SET_CHARMODE_TEXT 61
SRW.SET_CUSTOM_SPACING 62
SRW.SET_DISPLAY_NAME 63
SRW.SET_FIELD 64
SRW.SET_FIELD_CHAR 65
SRW.SET_FIELD_DATE 66
SRW.SET_FIELD_NUM 67
SRW.SET_FILL_PATTERN 68
SRW.SET_FONT_FACE 69
SRW.SET_FONT_SIZE 70
SRW.SET_FONT_STYLE 71
SRW.SET_FONT_WEIGHT 72

SRW.SET_FOREGROUND_BORDER_COLOR 73
SRW.SET_FOREGROUND_FILL_COLOR 74
SRW.SET_FORMAT_MASK 75
SRW.SET_HYPERLINK 76
SRW.SET_HYPERLINK_ATTRS 78
SRW.SET_JUSTIFICATION 79
SRW.SET_LINKTAG 80
SRW.SET_MAXROW 81
SRW.SET_PAGE_NAVIGATION_HTML 82
SRW.SET_PDF_ACTION 83
SRW.SET_PRINTER_TRAY 84
SRW.SET_SPACING 85
SRW.SET_TEXT_COLOR 86
SRW.INTEGER_ERROR 87
SRW.MAXROW_INERR 88
SRW.MAXROW_UNSET 89
SRW.MESSAGE 90
SRW.NULL_ARGUMENTS 91
SRW.PROGRAM_ABORT 92
SRW.REFERENCE 93
SRW.RUN_REPORT 94
SRW.RUN_REPORT_BATCHNO 96
SRW.RUN_REPORT_FAILURE 97
SRW.SET_ATTR 98
SRW.TRACE_ADD_OPTION 102
SRW.TRACE_END 103
SRW.TRACE_REM_OPTION 104
SRW.TRACE_START 105
SRW.TRACEOPTS.MASK 106
SRW.TRUNCATED_VALUE 107

SRW.UNKNOWN_QUERY 108
SRW.UNKNOWN_USER_EXIT 109
SRW.USER_EXIT 110
SRW.USER_EXIT20 111
SRW.USER_EXIT_FAILURE 112
TRIGGERS 113
W
HICH REPORT TRIGGER TO USE 114
R
EPORT TRIGGER ORDER OF EXECUTION 115
G
ROUP FILTER 117
Report Builder Reference
v
FORMULA 118
V
ALIDATION TRIGGER 119
F
ORMAT TRIGGER 120
A
CTION TRIGGER 123
R
EF CURSOR QUERY 124
A
FTER PARAMETER FORM TRIGGER 126
A
FTER REPORT TRIGGER 127
B
EFORE PARAMETER FORM TRIGGER 128
B

EFORE REPORT TRIGGER 129
B
ETWEEN PAGES TRIGGER 130
PROPERTIES 131
O
RACLE8 USAGE NOTES 132
A
BOUT THE PROPERTY PALETTE 133
A
NCHOR PROPERTIES 137
C
HILD EDGE PERCENT 139
C
HILD EDGE TYPE 140
C
HILD OBJECT NAME 141
C
OLLAPSE HORIZONTALLY 142
C
OLLAPSE VERTICALLY 143
P
ARENT EDGE PERCENT 145
P
ARENT EDGE TYPE 146
P
ARENT OBJECT NAME 147
B
OILERPLATE PROPERTIES 148
C
ONTAINS HTML TAGS 149

M
INIMUM WIDOW LINES 150
S
OURCE FILE FORMAT 151
S
OURCE FILENAME 152
T
YPE 153
L
INE STRETCH WITH FRAME 154
B
UTTON PROPERTIES 155
L
ABEL TYPE 156
T
EXT 157
I
CON NAME 158
T
YPE 159
M
ULTIMEDIA FILE 160
M
ULTIMEDIA FILE TYPE 161
M
ULTIMEDIA COLUMN 162
M
ULTIMEDIA COLUMN TYPE 163
PL/SQL T
RIGGER 164

C
HART PROPERTIES 165
C
HART FILENAME 167
C
HART HYPERLINK 168
C
HART PARAMETERS AND COLUMNS PROPERTIES 169
C
HART PARAMETER 170
R
EPORT COLUMN (FOR CHART PARAMETER) 171
C
HART QUERY 172
R
EPORT GROUP 173
C
HART COLUMN 174
R
EPORT COLUMN (FOR CHART COLUMN) 175
C
OMMON COLUMN PROPERTIES 176
B
REAK ORDER 177
C
OLUMN TYPE 179
C
OMMENT 180
D
ATABASE COLUMN NAME 181

D
ATATYPE 182
Report Builder Reference
vi
FILE FORMAT 183
N
AME 184
R
EAD FROM FILE 185
V
ALUE IF NULL 187
W
IDTH 188
S
ET BREAK ORDER 189
C
OMMON LAYOUT OBJECT PROPERTIES 190
C
OMMENTS 191
H
ORIZONTAL ELASTICITY 192
K
EEP WITH ANCHORING OBJECT 194
N
AME 195
P
AGE BREAK AFTER 196
P
AGE BREAK BEFORE 197
P

AGE PROTECT 198
B
ASE PRINTING ON 200
P
RINT OBJECT ON 201
P
RINTER CODE BEFORE 203
P
RINTER CODE AFTER 204
V
ERTICAL ELASTICITY 205
H
YPERLINK 208
H
YPERLINK DESTINATION 209
B
OOKMARK 210
A
PPLICATION COMMAND LINE (PDF) 211
C
ONDITIONAL FORMATTING 212
D
ISPLAY NAME 213
A
DDITIONAL HYPERLINK ATTRIBUTES 214
D
ATABASE COLUMN PROPERTIES 215
F
IELD PROPERTIES 216
S

OURCE DATATYPE 217
F
ORMAT MASK 218
D
ATE AND TIME FORMAT MASK SYNTAX 219
N
UMBER FORMAT MASK SYNTAX 220
V
ISIBLE 223
P
AGE NUMBERING 224
S
OURCE 227
F
ORMULA COLUMN PROPERTIES 228
F
RAME PROPERTIES 229
G
ROUP PROPERTIES 230
C
HILD DIMENSION 231
F
ILTER TYPE 232
N
AME 233
C
OMMENT 234
N
UMBER OF RECORDS 235
PL/SQL F

ILTER 236
D
ATA LINK PROPERTIES 237
C
HILD COLUMN 239
C
HILD QUERY 240
C
ONDITION 241
P
ARENT COLUMN 242
P
ARENT GROUP 243
SQL C
LAUSE 244
M
ATRIX PROPERTIES 245
C
ROSS PRODUCT GROUP 246
H
ORIZONTAL REPEATING FRAME 248
V
ERTICAL REPEATING FRAME 249
Report Builder Reference
vii
DATABASE COLUMN OBJECT PROPERTIES 250
OLE2
PROPERTIES 251
P
ARAMETER PROPERTIES 252

S
YSTEM PARAMETERS 253
A
DD 254
C
OMMENT 255
D
ATATYPE 256
H
IDE FIRST COLUMN 257
I
NITIAL VALUE 258
I
NPUT MASK 259
N
AME 260
R
EMOVE 261
R
ESTRICT LIST TO PREDETERMINED VALUES 262
SELECT S
TATEMENT/STATIC VALUES 263
V
ALIDATION TRIGGER 264
V
ALUE 265
W
IDTH 266
L
IST OF VALUES 267

P
ARAMETER FORM BOILERPLATE PROPERTIES 268
N
AME 269
T
YPE 270
P
ARAMETER FORM FIELD PROPERTIES 271
D
ATATYPE 272
N
AME 273
S
OURCE 274
P
LACEHOLDER COLUMN PROPERTIES 275
PL/SQL F
ORMULA 277
A
LPHABETICAL LIST OF PROPERTIES 278
Q
UERY PROPERTIES 282
C
OMMENT 283
E
XTERNAL QUERY SOURCE FILE 284
M
AXIMUM ROWS TO FETCH 285
N
AME 286

SQL Q
UERY STATEMENT 287
T
YPE 289
D
ATABASE REF COLUMN PROPERTIES 290
R
EPEATING FRAME PROPERTIES 291
C
OLUMN MODE 292
H
ORIZ. SPACE BETWEEN FRAMES 293
M
AXIMUM RECORDS PER PAGE 294
M
INIMUM WIDOW RECORDS 295
P
RINT DIRECTION 296
S
OURCE 297
V
ERT. SPACE BETWEEN FRAMES 298
R
EPORT PROPERTIES 299
U
NIT OF MEASUREMENT 300
M
AX. HORIZONTAL BODY PAGES 301
M
AX. VERTICAL BODY PAGES 302

P
ANEL PRINT ORDER 303
D
IRECTION 304
D
ISTRIBUTION 305
P
REVIEWER TITLE 306
R
OLE NAME 307
W
IDTH (PARAMETER FORM WINDOW) 308
H
EIGHT (PARAMETER FORM WINDOW) 309
Report Builder Reference
viii
NUMBER OF PAGES 310
P
AGE NAVIGATION CONTROL TYPE 311
P
AGE NAVIGATION CONTROL VALUE 312
B
EFORE REPORT TYPE 313
B
EFORE REPORT VALUE 314
A
FTER REPORT TYPE 315
A
FTER REPORT VALUE 316
B

EFORE PAGE TYPE 317
B
EFORE PAGE VALUE 318
A
FTER PAGE TYPE 319
A
FTER PAGE VALUE 320
B
EFORE FORM TYPE 321
B
EFORE FORM VALUE 322
A
FTER FORM TYPE 323
A
FTER FORM VALUE 324
D
ESIGN IN CHARACTER UNITS 325
U
SE PREVIEWER HINT LINE 326
P
REVIEWER HINT LINE TEXT 327
U
SE PREVIEWER STATUS LINE 328
P
REVIEWER STATUS LINE TEXT 329
I
NCLUDE BITMAPPED OBJECTS 330
I
NCLUDE BORDERS 331
D

ISABLE HOST MENU ITEM 332
D
ISABLE SPLIT SCREEN KEY 333
D
ISABLE ZOOM KEY 334
S
TART IN ZOOM 335
S
UPPRESS PREVIEWER TITLE 336
R
EF CURSOR QUERY PROPERTIES 337
PL/SQL S
TATEMENT 338
S
ECTION PROPERTIES 339
D
ISTRIBUTION 340
H
EIGHT 341
H
ORIZONTAL PANELS PER PAGE 342
O
RIENTATION 343
R
EPORT HEIGHT 344
R
EPORT WIDTH 345
V
ERTICAL PANELS PER PAGE 346
W

IDTH 347
S
UMMARY COLUMN PROPERTIES 348
C
OMPUTE AT 349
F
UNCTION 351
P
RODUCT ORDER 352
R
ESET AT 355
S
OURCE 357
T
EMPLATE PROPERTIES 358
A
LIGNMENT 359
A
LIGN SUMMARIES WITH FIELDS 360
B
ACKGROUND COLOR 361
B
ETWEEN FIELD AND LABELS (HORIZONTAL) 362
B
ETWEEN FRAME AND FIELDS (HORIZONTAL) 363
B
ETWEEN FRAME AND FIELDS (VERTICAL) 364
B
ETWEEN MASTER AND DETAIL (HORIZONTAL) 365
B

ETWEEN MASTER AND DETAIL (VERTICAL) 366
B
ETWEEN PAGE AND FRAMES (HORIZONTAL) 367
B
ETWEEN PAGE AND FRAMES (VERTICAL) 368
Report Builder Reference
ix
BETWEEN SIBLING FRAMES (HORIZONTAL) 369
B
ETWEEN SIBLING FRAMES (VERTICAL) 370
B
ORDERS 371
C
HARACTER JUSTIFICATION 372
D
ASH 373
D
ATE JUSTIFICATION 374
E
DGE FOREGROUND COLOR 375
E
DGE BACKGROUND COLOR 376
E
DGE PATTERN 377
F
IELDS PER LINE 378
F
ILL PATTERN 379
F
ONT 380

F
OREGROUND COLOR 381
I
MAGE 382
I
NTER-FIELD (HORIZONTAL) 383
I
NTER-FIELD (VERTICAL) 384
I
NTER-FRAME (HORIZONTAL) 385
I
NTER-FRAME (VERTICAL) 386
J
USTIFY 387
N
UMBER JUSTIFICATION 388
P
LACE LABELS ABOVE FIELDS 389
P
OSITION 390
S
TYLE 391
T
EXT 392
T
EXT COLOR 393
U
SE VERTICAL SPACING 394
EXECUTABLES 395
E

XECUTABLE NAMES 396
E
XECUTABLE INVOCATION 397
H
ELP ON COMMAND LINE OPTIONS 398
K
EYWORD USAGE 400
D
ATABASE LOGIN 401
E
XPLICIT LOGIN 402
USERID 403
A
UTOMATIC LOGIN 404
R
EMOTE LOGIN 405
RWBLD60 406
RWBLD60 C
OMMAND LINE ARGUMENTS 407
MODULE|REPORT (RWBLD60) 408
PARAMFORM (RWBLD60) 409
CMDFILE (RWBLD60) 410
ARRAYSIZE (RWBLD60) 411
DESTYPE (RWBLD60) 412
DESNAME (RWBLD60) 413
DESFORMAT (RWBLD60) 414
COPIES (RWBLD60) 415
CACHELOB (RWBLD60) 416
CURRENCY (RWBLD60) 417
THOUSANDS (RWBLD60) 418

DECIMAL (RWBLD60) 419
READONLY (RWBLD60) 420
BUFFERS (RWBLD60) 421
PAGESIZE (RWBLD60) 422
PROFILE (RWBLD60) 423
RUNDEBUG (RWBLD60) 424
Report Builder Reference
x
ONSUCCESS (RWBLD60) 425
ONFAILURE (RWBLD60) 426
ERRFILE (RWBLD60) 427
LONGCHUNK (RWBLD60) 428
ACCESS (RWBLD60) 429
ORIENTATION (RWBLD60) 430
BACKGROUND (RWBLD60) 431
MODE (RWBLD60) 432
PRINTJOB (RWBLD60) 433
TRACEFILE (RWBLD60) 434
TRACEMODE (RWBLD60) 435
TRACEOPTS (RWBLD60) 436
AUTOCOMMIT (RWBLD60) 437
NONBLOCKSQL (RWBLD60) 438
ROLE (RWBLD60) 439
BLANKPAGES (RWBLD60) 440
MAXIMIZE (RWBLD60) 441
DISABLEPRINT (RWBLD60) 442
DISABLEMAIL (RWBLD60) 443
DISABLEFILE (RWBLD60) 444
DISABLENEW (RWBLD60) 445
DELIMITER (RWBLD60) 446

CELLWRAPPER (RWBLD60) 447
DATEFORMATMASK (RWBLD60) 448
NUMBERFORMATMASK (RWBLD60) 449
DESTINATION (RWBLD60) 450
DISTRIBUTE (RWBLD60) 451
PAGESTREAM (RWBLD60) 452
EXPRESS_SERVER (RWBLD60) 453
<
PARAM> (RWBLD60) 455
RWCGI60 456
RWCLI60 457
RWCLI60 C
OMMAND LINE ARGUMENTS 458
PARAMFORM (RWCLI60) 459
DESTYPE (RWCLI60) 460
BATCH (RWCLI60) 461
BACKGROUND (RWCLI60) 462
SERVER (RWCLI60) 463
JOBNAME (RWCLI60) 464
SCHEDULE (RWCLI60) 465
TOLERANCE (RWCLI60) 466
RWCON60 467
RWCON60 C
OMMAND LINE ARGUMENTS 468
STYPE (RWCON60) 469
SOURCE (RWCON60) 470
DTYPE (RWCON60) 471
DEST (RWCON60) 472
CMDFILE (RWCON60) 473
LOGFILE (RWCON60) 474

OVERWRITE (RWCON60) 475
BATCH (RWCON60) 476
DUNIT (RWCON60) 477
PAGESIZE (RWCON60) 478
FORMSIZE (RWCON60) 479
RWMTS60 480
Report Builder Reference
xi
RWRQM60 481
RWRQV60 482
RWOWS60 483
RWRBE60 484
RWRUN60 485
RWRUN60 C
OMMAND LINE ARGUMENTS 486
MODULE|REPORT (RWRUN60) 487
PARAMFORM (RWRUN60) 488
CMDFILE (RWRUN60) 489
TERM (RWRUN60) 490
ARRAYSIZE (RWRUN60) 491
DESTYPE (RWRUN60) 492
DESNAME (RWRUN60) 493
DESFORMAT (RWRUN60) 494
COPIES (RWRUN60) 495
CACHELOB (RWRUN60) 496
CURRENCY (RWRUN60) 497
THOUSANDS (RWRUN60) 498
DECIMAL (RWRUN60) 499
READONLY (RWRUN60) 500
LOGFILE (RWRUN60) 501

BUFFERS (RWRUN60) 502
BATCH (RWRUN60) 503
PAGESIZE (RWRUN60) 504
PROFILE (RWRUN60) 505
RUNDEBUG (RWRUN60) 506
ONSUCCESS (RWRUN60) 507
ONFAILURE (RWRUN60) 508
KEYIN (RWRUN60) 509
KEYOUT (RWRUN60) 510
ERRFILE (RWRUN60) 511
LONGCHUNK (RWRUN60) 512
ORIENTATION (RWRUN60) 513
BACKGROUND (RWRUN60) 514
MODE (RWRUN60) 515
PRINTJOB (RWRUN60) 516
TRACEFILE (RWRUN60) 517
TRACEMODE (RWRUN60) 518
TRACEOPTS (RWRUN60) 519
AUTOCOMMIT (RWRUN60) 520
NONBLOCKSQL (RWRUN60) 521
ROLE (RWRUN60) 522
BLANKPAGES (RWRUN60) 523
YES (RWRUN60) 524
DISABLEPRINT (RWRUN60) 525
DISABLEMAIL (RWRUN60) 526
DISABLEFILE (RWRUN60) 527
DISABLENEW (RWRUN60) 528
DESTINATION (RWRUN60) 529
DISTRIBUTE (RWRUN60) 530
DELIMITER (RWRUN60) 531

CELLWRAPPER (RWRUN60) 532
DATEFORMATMASK (RWRUN60) 533
NUMBERFORMATMASK (RWRUN60) 534
PAGESTREAM (RWRUN60) 535
Report Builder Reference
xii
EXPRESS_SERVER (RWRUN60) 536
<
PARAM> (RWRUN60) 538
Report Builder Reference
xiii
Send Us Your Comments
Oracle Reports Reference
Part No. A66243-02
Oracle Corporation welcomes your comments and suggestions on the quality
and usefulness of this publication. Your input is an important part of the
information used for revision.
•
Did you find any errors?
•
Is the information clearly presented?
•
Do you need more information? If so, where?
•
Are the examples correct? Do you need more examples?
•
What features did you like most about this manual?
If you find any errors or have any other suggestions for improvement, you
can send comments by electronic mail to Please
indicate the part number, section, and page number (if available).

Report Builder Reference
xiv
Report Builder Reference
xv
Preface
Welcome to Release 6.0 of the Oracle Reports Reference.
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
xvi
Prerequisites
You should be familiar with your computer and its operating system. For
example, you should know the commands for deleting and copying files and
understand the concepts of search paths, subdirectories, and path names.
Refer to your Microsoft Windows 95 or NT and DOS product
documentation for more information.
You should also understand the fundamentals of Microsoft Windows, such
as the elements of an application window. You should also be familiar with
such programs as the Explorer, Taskbar or Task Manager, and Registry.

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. Text typed on a PC is not
case-sensitive unless otherwise noted.
In commands, punctuation other than brackets and
vertical bars must be entered exactly as shown.
lowercase Lowercase characters in a command statement
represent a variable. Substitute an appropriate value.
UPPERCASE Uppercase characters within the text represent
command names, SQL reserved words, and keywords.
boldface Boldface is used to indicate user interface items such
as menu choices and buttons.
C> C> represents the DOS prompt. Your prompt may
differ.
Related Publications
You may also wish to consult the following Oracle documentation:
Title Part Number
Oracle Developer: Guidelines for Building Applications A58766
SQL*Plus User’s Guide and Reference Version 3.1 A24801
Report Builder Reference
1
Built-Ins
Report Builder Reference
2
Built-in packages
Oracle provides several packaged procedures which you can use when building or debugging your PL/SQL-
based applications.
Your PL/SQL code can make use of the procedures, functions, and exceptions in the following client-side

built-in packages:
•
Oracle Developer built-in packages
•
SRW built-in packages
Report Builder Reference
3
SRW.SET_ATTR attributes
ACTION
AFTCODE
AFTFORM_ESCAPE
AFTPAGE_ESCAPE
AFTREPORT_ESCAPE
BBCOLOR
BEFCODE
BEFFORM_ESCAPE
BEFPAGE_ESCAPE
BEFREPORT_ESCAPE
BFCOLOR
BOOKMARK
BORDERWIDTH
BORDPATT
FACE
FBCOLOR
FFCOLOR
FILLPATT
FORMATMASK
GCOLOR
GSPACING
HJUST

HYPERLINK
LINKTAG
PRINTER_INTRAY
STYLE
SZ
TEXT
WEIGHT
Report Builder Reference
4
ACTION
New Feature: It is now more convenient to set this attribute using the SRW.SET_PDF_ACTION
procedure. Setting this attribute via SRW.SET_ATTR is still supported for compatibility, but it is highly
recommended that you use the new, simplified procedure.
Description Is a command line that will be executed on the local machine when the object is clicked in the
PDF viewer.
Note: An object that is associated with an action cannot also be the source of a Web link.
Values
Any valid command line on the local machine (e.g., c:\orawin\bin\rwrun60
userid=scott/tiger report=example.rdf or /usr/local/bin/phone smith)
ACTION restrictions
ACTION is only available for PDF output.
ACTION should only be set in the following triggers:
Format
ACTION example
Note: This example illustrates using SRW.SET ATTR to set the ACTION attribute. It is now more
convenient to set this attribute using the SRW.SET_PDF_ACTION procedure. Setting this attribute via
SRW.SET_ATTR is still supported for compatibility, but it is highly recommended that you use the new,
simplified procedure.
/* 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.
*/
function B_2FormatTrigger return boolean is
begin
srw.attr.mask := srw.ACTION_ATTR;
srw.attr.action := 'c:\orawin\bin\rwrun60' ||
'userid=scott/tiger ' ||
'report=example.rdf';
srw.set_attr(0,srw.attr);
return (TRUE);
end;
Report Builder Reference
5
AFTCODE
New Feature: It is now more convenient to set this attribute using the
SRW.SET_AFTER_PRINTING_CODE procedure. Setting this attribute via SRW.SET_ATTR is still
supported for compatibility, but it is highly recommended that you use the new, simplified procedure.
Description Is 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.
AFTCODE is only used when running your report in character-mode.
Values
A string of the form &number, where number is a number assigned to a packaged Report Builder printer
escape sequence or a printer escape sequence that you created.
Report Builder Reference
6
AFTFORM_ESCAPE
New Feature: It is now more convenient to set this attribute using the SRW.SET_AFTER_FORM_HTML
procedure. Setting this attribute via SRW.SET_ATTR is still supported for compatibility, but it is highly
recommended that you use the new, simplified procedure.

Description Is any text, graphics, or HTML commands that you want to appear at the bottom of the HTML
Parameter Form. This attribute is useful for placing a logo or some standard links on the Parameter Form .
Values
You must specify two items for this attribute:
AFTFORM_ESCAPE_TYPE can be set to either SRW.FILE_ESCAPE or SRW.TEXT_ESCAPE.
AFTFORM_ESCAPE_VALUE can be a filename or a text string containing valid HTML
depending upon what you specified for AFTFORM_ESCAPE_TYPE. If you specify a file, the
File searching method is used to find it.
Report Builder Reference
7
AFTPAGE_ESCAPE
New Feature: It is now more convenient to set this attribute using the SRW.SET_AFTER_PAGE_HTML
procedure. Setting this attribute via SRW.SET_ATTR is still supported for compatibility, but it is highly
recommended that you use the new, simplified procedure.
Description Is any text, graphics, or HTML commands that you want to appear at the end of pages of your
document. This attribute is useful for placing a logo or some standard links at the end of each page in an
HTML document.
Values
You must specify two items for this attribute:
AFTPAGE_ESCAPE_TYPE can be set to either SRW.FILE_ESCAPE or SRW.TEXT_ESCAPE.
AFTPAGE_ESCAPE_VALUE can be a filename or a text string containing valid HTML
depending upon what you specified for AFTPAGE_ESCAPE_TYPE. If you specify a file, the
File searching method is used to find it.
AFTPAGE_ESCAPE restrictions
When you specify SRW.SET_ATTR for this attribute you must use SRW.REPORT_ID as the
object_id:
SRW.SET_ATTR(SRW.REPORT_ID, SRW.ATTR);
The default HTML included at the end of a page is shown below. It is not required unless
you want the default separator line to appear between pages.
<hr size=5 noshade>

If you want the AFTPAGE_ESCAPE to apply to every page of the report, you should specify
it in a trigger that fires before the report begins formatting, such as the Before Report trigger.
If you want the AFTPAGE_ESCAPE to apply only to the current page, you should specify it
in a format trigger for an object on that page.
Graphic page separator example
Note: This example illustrates using SRW.SET_ATTR to set the AFTPAGE_ESCAPE attribute. It is now
more convenient to set this attribute using the SRW.SET_AFTER_PAGE_HTML procedure. Setting this
attribute via SRW.SET_ATTR is still supported for compatibility, but it is highly recommended that you
use the new, simplified procedure.
/* The example below inserts a GIF file as a
** page separator.
*/
function BeforeReport return boolean is
begin
if ((upper(:MODE) != ’CHARACTER’) and
(upper(:DESFORMAT) = ’HTML’)) then
SRW.ATTR.MASK := SRW.AFTPAGE_ESCAPE_ATTR;
SRW.ATTR.AFTPAGE_ESCAPE_TYPE := SRW.TEXT_ESCAPE;
SRW.ATTR.AFTPAGE_ESCAPE_VALUE := ’<CENTER>’ ||
’<IMG ALT="Ruler" SRC="line.gif" VSPACE=10>’ ||
’<BR></CENTER>’;
SRW.SET_ATTR(SRW.REPORT_ID, SRW.ATTR);
end if;
return (TRUE);
end;
Report Builder Reference
8
AFTREPORT_ESCAPE
New Feature: It is now more convenient to set this attribute using the
SRW.SET_AFTER_REPORT_HTML procedure. Setting this attribute via SRW.SET_ATTR is still

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

begin
if ((upper(:MODE) != ’CHARACTER’) and
(upper(:DESFORMAT) = ’HTML’)) then
SRW.ATTR.MASK := SRW.AFTREPORT_ESCAPE_ATTR;
SRW.ATTR.AFTREPORT_ESCAPE_TYPE := SRW.TEXT_ESCAPE;
SRW.ATTR.AFTREPORT_ESCAPE_VALUE := ’<CENTER>’ ||
’<A HREF=" ||
’Oracle Corporation</A> -’ ||
chr(10) ||
’<A HREF=" ||
’Netscape</A> </CENTER>’ ||
’</BODY> </HTML>’;
SRW.SET_ATTR(SRW.REPORT_ID, SRW.ATTR);
end if;
return (TRUE);
end;
Report Builder Reference
9
BBCOLOR
New Feature: It is now more convenient to set this attribute using the
SRW.SET_BACKGROUND_BORDER_COLOR procedure. Setting this attribute via SRW.SET_ATTR
is still supported for compatibility, but it is highly recommended that you use the new, simplified procedure.
Description Is the background border color of the object. This attribute is ignored in character mode.
Values
A valid color name.