Oracle ® Developer Report Builder Reference RELEASE 6.0 October, 1998 Enabling the Information Age ™ Through Network Computing Report Builder Referenceii Oracle ® Developer Report Builder Reference Release 6.0 The part number for this volume is A66598-01 Copyright © 1998, 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. 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 BUILT-IN PACKAGES 2 SRW.SET_ATTR ATTRIBUTES 3 ACTION 4 AFTCODE 5 AFTFORM_ESCAPE 6 AFTPAGE_ESCAPE 7 AFTREPORT_ESCAPE 8 BBCOLOR 10 BEFCODE 11 BEFFORM_ESCAPE 12 BEFPAGE_ESCAPE 13 BEFREPORT_ESCAPE 14 BFCOLOR 16 BOOKMARK 17 BORDERWIDTH 19 BORDPATT 20 FACE 21 FBCOLOR 22 FFCOLOR 23 FILLPATT 24 FORMATMASK 25 GCOLOR 26 GSPACING 27 HJUST 28 HYPERLINK 29 LINKTAG 31 PRINTER_INTRAY 32 STYLE 33 SZ 34 TEXT 35 WEIGHT 36 THE REPORT BUILDER PL/SQL PACKAGE (SRW) 37 SRW.BREAK 38 SRW.CONTEXT_FAILURE 39 SRW.DO_SQL 40 SRW.DO_SQL_FAILURE 42 SRW.FILE_ESCAPE 43 SRW.GETERR_RUN 44 SRW.GET_PAGE_NUM 45 SRW.TEXT_ESCAPE 46 SET ATTRIBUTES PROCEDURES 47 SRW.SET_AFTER_FORM_HTML 49 SRW.SET_AFTER_PAGE_HTML 50 SRW.SET_AFTER_PRINTING_CODE 51 SRW.SET_AFTER_REPORT_HTML 52 SRW.SET_BACKGROUND_BORDER_COLOR 53 SRW.SET_BACKGROUND_FILL_COLOR 54 SRW.SET_BEFORE_FORM_HTML 55 Report Builder Referenceiv SRW.SET_BEFORE_PAGE_HTML 56 SRW.SET_BEFORE_PRINTING_CODE 57 SRW.SET_BEFORE_REPORT_HTML 58 SRW.SET_BOOKMARK 60 SRW.SET_BORDER_PATTERN 62 SRW.SET_BORDER_WIDTH 63 SRW.SET_CHARMODE_TEXT 64 SRW.SET_CUSTOM_SPACING 65 SRW.SET_DISPLAY_NAME 66 SRW.SET_FIELD 67 SRW.SET_FIELD_CHAR 68 SRW.SET_FIELD_DATE 69 SRW.SET_FIELD_NUM 70 SRW.SET_FILL_PATTERN 71 SRW.SET_FONT_FACE 72 SRW.SET_FONT_SIZE 73 SRW.SET_FONT_STYLE 74 SRW.SET_FONT_WEIGHT 75 SRW.SET_FOREGROUND_BORDER_COLOR 76 SRW.SET_FOREGROUND_FILL_COLOR 77 SRW.SET_FORMAT_MASK 78 SRW.SET_HYPERLINK 79 SRW.SET_HYPERLINK_ATTRS 81 SRW.SET_JUSTIFICATION 82 SRW.SET_LINKTAG 83 SRW.SET_MAXROW 84 SRW.SET_PAGE_NAVIGATION_HTML 85 SRW.SET_PDF_ACTION 86 SRW.SET_PRINTER_TRAY 87 SRW.SET_SPACING 88 SRW.SET_TEXT_COLOR 89 SRW.INTEGER_ERROR 90 SRW.MAXROW_INERR 91 SRW.MAXROW_UNSET 92 SRW.MESSAGE 93 SRW.NULL_ARGUMENTS 95 SRW.PROGRAM_ABORT 96 SRW.REFERENCE 97 SRW.RUN_REPORT 98 SRW.RUN_REPORT_BATCHNO 100 SRW.RUN_REPORT_FAILURE 101 SRW.SET_ATTR 102 SRW.TRACE_ADD_OPTION 106 SRW.TRACE_END 107 SRW.TRACE_REM_OPTION 108 SRW.TRACE_START 109 SRW.TRACEOPTS.MASK 110 SRW.TRUNCATED_VALUE 111 SRW.UNKNOWN_QUERY 112 SRW.UNKNOWN_USER_EXIT 113 SRW.USER_EXIT 114 SRW.USER_EXIT20 115 Report Builder Reference v SRW.USER_EXIT_FAILURE 116 TRIGGERS 117 WHICH REPORT TRIGGER TO USE 118 REPORT TRIGGER ORDER OF EXECUTION 119 GROUP FILTER 121 FORMULA 122 VALIDATION TRIGGER 124 FORMAT TRIGGER 125 ACTION TRIGGER 128 REF CURSOR QUERY 129 AFTER PARAMETER FORM TRIGGER 131 AFTER REPORT TRIGGER 132 BEFORE PARAMETER FORM TRIGGER 133 BEFORE REPORT TRIGGER 134 BETWEEN PAGES TRIGGER 135 PROPERTIES 137 ORACLE8 USAGE NOTES 138 ABOUT THE PROPERTY PALETTE 140 ANCHOR PROPERTIES 144 CHILD EDGE PERCENT 146 CHILD EDGE TYPE 147 CHILD OBJECT NAME 148 COLLAPSE HORIZONTALLY 149 COLLAPSE VERTICALLY 150 PARENT EDGE PERCENT 152 PARENT EDGE TYPE 153 PARENT OBJECT NAME 154 BOILERPLATE PROPERTIES 155 CONTAINS HTML TAGS 156 MINIMUM WIDOW LINES 157 SOURCE FILE FORMAT 158 SOURCE FILENAME 159 TYPE 160 LINE STRETCH WITH FRAME 161 BUTTON PROPERTIES 163 LABEL TYPE 165 TEXT 166 ICON NAME 167 TYPE 168 MULTIMEDIA FILE 169 MULTIMEDIA FILE TYPE 170 MULTIMEDIA COLUMN 171 MULTIMEDIA COLUMN TYPE 172 PL/SQL TRIGGER 173 CHART PROPERTIES 174 CHART FILENAME 176 CHART HYPERLINK 177 CHART PARAMETERS AND COLUMNS PROPERTIES 178 CHART PARAMETER 179 REPORT COLUMN (FOR CHART PARAMETER) 180 CHART QUERY 181 REPORT GROUP 182 Report Builder Referencevi CHART COLUMN 183 REPORT COLUMN (FOR CHART COLUMN) 184 COMMON COLUMN PROPERTIES 185 BREAK ORDER 186 COLUMN TYPE 188 COMMENT 189 DATABASE COLUMN NAME 190 DATATYPE 191 FILE FORMAT 192 NAME 193 READ FROM FILE 194 VALUE IF NULL 196 WIDTH 197 SET BREAK ORDER 198 COMMON LAYOUT OBJECT PROPERTIES 199 COMMENTS 201 HORIZONTAL ELASTICITY 202 KEEP WITH ANCHORING OBJECT 204 NAME 206 PAGE BREAK AFTER 208 PAGE BREAK BEFORE 209 PAGE PROTECT 210 BASE PRINTING ON 212 PRINT OBJECT ON 213 PRINTER CODE BEFORE 216 PRINTER CODE AFTER 217 VERTICAL ELASTICITY 218 HYPERLINK 222 HYPERLINK DESTINATION 223 BOOKMARK 224 APPLICATION COMMAND LINE (PDF) 225 CONDITIONAL FORMATTING 226 DISPLAY NAME 227 ADDITIONAL HYPERLINK ATTRIBUTES 228 DATABASE COLUMN PROPERTIES 229 FIELD PROPERTIES 230 SOURCE DATATYPE 232 FORMAT MASK 233 DATE AND TIME FORMAT MASK SYNTAX 234 NUMBER FORMAT MASK SYNTAX 236 VISIBLE 240 PAGE NUMBERING 242 SOURCE 245 FORMULA COLUMN PROPERTIES 247 FRAME PROPERTIES 248 GROUP PROPERTIES 249 CHILD DIMENSION 250 FILTER TYPE 251 NAME 252 COMMENT 253 NUMBER OF RECORDS 254 PL/SQL FILTER 255 Report Builder Reference vii DATA LINK PROPERTIES 256 CHILD COLUMN 259 CHILD QUERY 260 CONDITION 261 PARENT COLUMN 262 PARENT GROUP 263 SQL CLAUSE 264 MATRIX PROPERTIES 265 CROSS PRODUCT GROUP 266 HORIZONTAL REPEATING FRAME 268 VERTICAL REPEATING FRAME 269 DATABASE COLUMN OBJECT PROPERTIES 270 OLE2 PROPERTIES 271 PARAMETER PROPERTIES 272 SYSTEM PARAMETERS 273 ADD 274 COMMENT 275 DATATYPE 276 HIDE FIRST COLUMN 277 INITIAL VALUE 278 INPUT MASK 279 NAME 280 REMOVE 281 RESTRICT LIST TO PREDETERMINED VALUES 282 SELECT STATEMENT/STATIC VALUES 283 VALIDATION TRIGGER 284 VALUE 285 WIDTH 286 LIST OF VALUES 287 PARAMETER FORM BOILERPLATE PROPERTIES 288 NAME 289 TYPE 290 PARAMETER FORM FIELD PROPERTIES 291 DATATYPE 292 NAME 293 SOURCE 294 PLACEHOLDER COLUMN PROPERTIES 295 PL/SQL FORMULA 297 ALPHABETICAL LIST OF PROPERTIES 298 QUERY PROPERTIES 304 COMMENT 305 EXTERNAL QUERY SOURCE FILE 306 MAXIMUM ROWS TO FETCH 307 NAME 308 SQL QUERY STATEMENT 309 TYPE 311 DATABASE REF COLUMN PROPERTIES 312 REPEATING FRAME PROPERTIES 313 COLUMN MODE 314 HORIZ. SPACE BETWEEN FRAMES 315 MAXIMUM RECORDS PER PAGE 316 MINIMUM WIDOW RECORDS 317 Report Builder Referenceviii PRINT DIRECTION 318 SOURCE 320 VERT. SPACE BETWEEN FRAMES 321 REPORT PROPERTIES 322 UNIT OF MEASUREMENT 324 MAX. HORIZONTAL BODY PAGES 325 MAX. VERTICAL BODY PAGES 326 PANEL PRINT ORDER 327 DIRECTION 328 DISTRIBUTION 329 PREVIEWER TITLE 330 ROLE NAME 331 WIDTH (PARAMETER FORM WINDOW) 332 HEIGHT (PARAMETER FORM WINDOW) 333 NUMBER OF PAGES 334 PAGE NAVIGATION CONTROL TYPE 335 PAGE NAVIGATION CONTROL VALUE 336 BEFORE REPORT TYPE 337 BEFORE REPORT VALUE 338 AFTER REPORT TYPE 339 AFTER REPORT VALUE 340 BEFORE PAGE TYPE 341 BEFORE PAGE VALUE 342 AFTER PAGE TYPE 343 AFTER PAGE VALUE 344 BEFORE FORM TYPE 345 BEFORE FORM VALUE 346 AFTER FORM TYPE 347 AFTER FORM VALUE 348 DESIGN IN CHARACTER UNITS 349 USE PREVIEWER HINT LINE 350 PREVIEWER HINT LINE TEXT 351 USE PREVIEWER STATUS LINE 352 PREVIEWER STATUS LINE TEXT 353 INCLUDE BITMAPPED OBJECTS 354 INCLUDE BORDERS 355 DISABLE HOST MENU ITEM 356 DISABLE SPLIT SCREEN KEY 357 DISABLE ZOOM KEY 358 START IN ZOOM 359 SUPPRESS PREVIEWER TITLE 360 REF CURSOR QUERY PROPERTIES 361 PL/SQL STATEMENT 362 SECTION PROPERTIES 363 DISTRIBUTION 364 HEIGHT 365 HORIZONTAL PANELS PER PAGE 366 ORIENTATION 367 REPORT HEIGHT 368 REPORT WIDTH 369 VERTICAL PANELS PER PAGE 370 WIDTH 371 Report Builder Reference ix SUMMARY COLUMN PROPERTIES 372 COMPUTE AT 373 FUNCTION 376 PRODUCT ORDER 377 RESET AT 381 SOURCE 383 TEMPLATE PROPERTIES 384 ALIGNMENT 386 ALIGN SUMMARIES WITH FIELDS 387 BACKGROUND COLOR 388 BETWEEN FIELD AND LABELS (HORIZONTAL) 389 BETWEEN FRAME AND FIELDS (HORIZONTAL) 390 BETWEEN FRAME AND FIELDS (VERTICAL) 391 BETWEEN MASTER AND DETAIL (HORIZONTAL) 392 BETWEEN MASTER AND DETAIL (VERTICAL) 393 BETWEEN PAGE AND FRAMES (HORIZONTAL) 394 BETWEEN PAGE AND FRAMES (VERTICAL) 395 BETWEEN SIBLING FRAMES (HORIZONTAL) 396 BETWEEN SIBLING FRAMES (VERTICAL) 397 BORDERS 398 CHARACTER JUSTIFICATION 399 DASH 400 DATE JUSTIFICATION 401 EDGE FOREGROUND COLOR 402 EDGE BACKGROUND COLOR 403 EDGE PATTERN 404 FIELDS PER LINE 405 FILL PATTERN 406 FONT 407 FOREGROUND COLOR 408 IMAGE 409 INTER-FIELD (HORIZONTAL) 410 INTER-FIELD (VERTICAL) 411 INTER-FRAME (HORIZONTAL) 412 INTER-FRAME (VERTICAL) 413 JUSTIFY 414 NUMBER JUSTIFICATION 415 PLACE LABELS ABOVE FIELDS 416 POSITION 417 STYLE 418 TEXT 419 TEXT COLOR 420 USE VERTICAL SPACING 421 EXECUTABLES 423 EXECUTABLE NAMES 424 EXECUTABLE INVOCATION 425 HELP ON COMMAND LINE OPTIONS 426 KEYWORD USAGE 428 DATABASE LOGIN 429 EXPLICIT LOGIN 430 USERID 431 AUTOMATIC LOGIN 432 Report Builder Referencex REMOTE LOGIN 433 RWBLD60 434 RWBLD60 COMMAND LINE ARGUMENTS 435 MODULE|REPORT (RWBLD60) 437 PARAMFORM (RWBLD60) 438 CMDFILE (RWBLD60) 439 ARRAYSIZE (RWBLD60) 440 DESTYPE (RWBLD60) 441 DESNAME (RWBLD60) 442 DESFORMAT (RWBLD60) 443 COPIES (RWBLD60) 444 CACHELOB (RWBLD60) 445 CURRENCY (RWBLD60) 446 THOUSANDS (RWBLD60) 447 DECIMAL (RWBLD60) 448 READONLY (RWBLD60) 449 BUFFERS (RWBLD60) 450 PAGESIZE (RWBLD60) 451 PROFILE (RWBLD60) 452 RUNDEBUG (RWBLD60) 453 ONSUCCESS (RWBLD60) 454 ONFAILURE (RWBLD60) 455 ERRFILE (RWBLD60) 456 LONGCHUNK (RWBLD60) 457 ACCESS (RWBLD60) 458 ORIENTATION (RWBLD60) 459 BACKGROUND (RWBLD60) 460 MODE (RWBLD60) 461 PRINTJOB (RWBLD60) 462 TRACEFILE (RWBLD60) 463 TRACEMODE (RWBLD60) 464 TRACEOPTS (RWBLD60) 465 AUTOCOMMIT (RWBLD60) 466 NONBLOCKSQL (RWBLD60) 467 ROLE (RWBLD60) 468 BLANKPAGES (RWBLD60) 469 MAXIMIZE (RWBLD60) 470 DISABLEPRINT (RWBLD60) 471 DISABLEMAIL (RWBLD60) 472 DISABLEFILE (RWBLD60) 473 DISABLENEW (RWBLD60) 474 DELIMITER (RWBLD60) 475 CELLWRAPPER (RWBLD60) 476 DATEFORMATMASK (RWBLD60) 477 NUMBERFORMATMASK (RWBLD60) 478 DESTINATION (RWBLD60) 479 DISTRIBUTE (RWBLD60) 480 PAGESTREAM (RWBLD60) 481 EXPRESS_SERVER (RWBLD60) 482 <PARAM> (RWBLD60) 484 RWCGI60 485 RWCLI60 486 [...]... comments by electronic mail to oddoc@us .oracle. com Please indicate the part number, section, and page number (if available) Report Builder Reference xiii xiv Report Builder Reference Preface Welcome to Release 6.0 of the Oracle Developer Report Builder Reference This reference guide includes information to help you effectively work with Oracle Developer Report Builder and contains detailed information... SRW.AFTREPORT_ESCAPE_ATTR; SRW.ATTR.AFTREPORT_ESCAPE_TYPE := SRW.TEXT_ESCAPE; SRW.ATTR.AFTREPORT_ESCAPE_VALUE := '' || '' || 'Oracle Corporation -' || chr(10) || '' || 'Netscape ' || ' '; SRW.SET_ATTR(SRW .REPORT_ ID, SRW.ATTR); end if; 8 Report Builder Reference return (TRUE); end; Report Builder Reference. .. prompt may differ Related Publications You may also wish to consult the following Oracle documentation: Title Oracle Developer: Guidelines for Building Applications A58766 SQL*Plus User's Guide and Reference Version 3.1 xvi Part Number A24801 Report Builder Reference Built-Ins Report Builder Reference 1 Built-in packages Oracle provides several packaged procedures which you can use when building or debugging... • Oracle Developer built-in packages • SRW built-in packages 2 Report Builder Reference 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. .. 564 NUMBERFORMATMASK (RWRUN60) 565 PAGESTREAM (RWRUN60) 566 EXPRESS_SERVER (RWRUN60) 567 (RWRUN60) 569 xii Report Builder Reference Send Us Your Comments Oracle Developer Report Builder Reference Part No A66598-01 Oracle Corporation welcomes your comments and suggestions on the quality and usefulness of this publication Your input is an important part of the... SRW.ATTR.BEFREPORT_ESCAPE_VALUE := 'logo.htm'; SRW.ATTR.AFTREPORT_ESCAPE_TYPE := SRW.TEXT_ESCAPE; SRW.ATTR.AFTREPORT_ESCAPE_VALUE := '' || 14 Report Builder Reference ' Questions? - ' || '' || 'webmaster@xyztech.com' || '' || ''; SRW.SET_ATTR(SRW .REPORT_ ID, SRW.ATTR); end if; return (TRUE); end; Report Builder Reference 15 BFCOLOR New Feature: It... 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 Developer Report Builder Report Builder Reference xv Prerequisites You should be familiar with your computer and its operating system For example, you should know the commands... HTML for BEFREPORT_ESCAPE is located in a file ** named logo.htm The HTML for AFTREPORT_ESCAPE is ** specified within the PL/SQL itself */ function BeforeReport return boolean is begin if ((upper(:MODE) != 'CHARACTER') and (upper(:DESFORMAT) = 'HTML')) then SRW.ATTR.MASK := SRW.BEFREPORT_ESCAPE_ATTR + SRW.AFTREPORT_ESCAPE_ATTR; SRW.ATTR.BEFREPORT_ESCAPE_TYPE := SRW.FILE_ESCAPE; SRW.ATTR.BEFREPORT_ESCAPE_VALUE... SRW.SET_ATTR(SRW .REPORT_ ID, SRW.ATTR); n The default HTML included at the beginning of a report is shown below If you use BEFREPORT_ESCAPE to replace this text, you must ensure that it contains the equivalent HTML commands n BEFREPORT_ESCAPE should be set in a trigger that fires before the report starts formatting, such as the Before Report trigger Before and after report escape... SRW .REPORT_ ID as the object_id: SRW.SET_ATTR(SRW .REPORT_ ID, SRW.ATTR); n 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 n 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 . the Oracle Developer Report Builder Reference. This reference guide includes information to help you effectively work with Oracle Developer Report Builder. 567 <PARAM> (RWRUN60) 569 Report Builder Reference xiii Send Us Your Comments Oracle Developer Report Builder Reference Part No. A66598-01 Oracle Corporation