Oracle Developer Report Builder Reference

8/9/2019 Oracle Developer Report Builder Reference

1/593

Oracle ® DeveloperReport Builder ReferenceRELEASE 6.0

October, 1998

Enabling the Information Age ™ Through Network Computing


2/593

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 allappropriate fail-safe, back up, redundancy and other measures to ensure the safe use ofsuch applications if the Programs are used for such purposes, and Oracle disclaims liabilityfor any damages caused by such use of the Programs.

This Program contains proprietary information of Oracle Corporation; it is provided under alicense agreement containing restrictions on use and disclosure and is also protected bycopyright, patent and other intellectual property law. Reverse engineering of the software isprohibited.

The information contained in this document is subject to change without notice. If you findany problems in the documentation, please report them to us in writing. Oracle Corporationdoes not warrant that this document is error free. No part of this document may bereproduced or transmitted in any form or by any means, electronic or mechanical, for anypurpose, without the express written permission of Oracle Corporation

If this Program is delivered to a U.S. Government Agency of the Department of Defense, thenit 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 besubject to the licensing restrictions set forth in the applicable Oracle license agreement.Otherwise, Programs delivered subject to the Federal Acquisition Regulations are "restrictedcomputer software" and use, duplication and disclosure of the Programs shall be subject to therestrictions 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, OracleForms, Oracle Graphics, Oracle Installer, Oracle Reports, Oracle7, Oracle8, Oracle WebApplication Server, Personal Oracle, Personal Oracle Lite, and PL/SQL are trademarks orregistered trademarks of Oracle Corporation. All other company or product names mentionedare used for identification purposes only and may be trademarks of their respective owners.


3/593

Report Builder Reference iii

Table of ContentsBUILT-INS................................................................................................................ 1

BUILT-IN PACKAGES ........................................................................................... 2SRW.SET_ATTR ATTRIBUTES ........................................................................... 3ACTION............................................................................................................. 4AFTCODE..........................................................................................................5AFTFORM_ESCAPE ........................................................................................ 6AFTPAGE_ESCAPE......................................................................................... 7AFTREPORT_ESCAPE....................................................................................8BBCOLOR........................................................................................................10BEFCODE ........................................................................................................ 11BEFFORM_ESCAPE.......................................................................................12BEFPAGE_ESCAPE ....................................................................................... 13BEFREPORT_ESCAPE................................................................................... 14BFCOLOR........................................................................................................ 16BOOKMARK................................................................................................... 17

BORDERWIDTH ............................................................................................19BORDPATT ..................................................................................................... 20FACE................................................................................................................21FBCOLOR........................................................................................................ 22FFCOLOR ........................................................................................................ 23FILLPATT........................................................................................................ 24FORMATMASK..............................................................................................25GCOLOR.......................................................................................................... 26GSPACING...................................................................................................... 27HJUST ..............................................................................................................28HYPERLINK ................................................................................................... 29LINKTAG........................................................................................................ 31PRINTER_INTRAY ........................................................................................ 32STYLE............................................................................................................... 33SZ...................................................................................................................... 34TEXT.................................................................................................................35WEIGHT..........................................................................................................36THE REPORT BUILDER PL/SQL PACKAGE (SRW)..........................................37SRW.BREAK.................................................................................................... 38SRW.CONTEXT_FAILURE...........................................................................39SRW.DO_SQL.................................................................................................40SRW.DO_SQL_FAILURE ..............................................................................42SRW.FILE_ESCAPE ....................................................................................... 43SRW.GETERR_RUN ...................................................................................... 44SRW.GET_PAGE_NUM................................................................................45

SRW.TEXT_ESCAPE...................................................................................... 46SET ATTRIBUTESPROCEDURES......................................................................... 47SRW.SET_AFTER_FORM_HTML................................................................49SRW.SET_AFTER_PAGE_HTML ................................................................50SRW.SET_AFTER_PRINTING_CODE ........................................................51SRW.SET_AFTER_REPORT_HTML............................................................52SRW.SET_BACKGROUND_BORDER_COLOR ........................................53SRW.SET_BACKGROUND_FILL_COLOR................................................ 54SRW.SET_BEFORE_FORM_HTML ............................................................. 55


4/593


5/593

Report Builder Reference v

SRW.USER_EXIT_FAILURE.......................................................................116TRIGGERS............................................................................................................117

WHICH REPORT TRIGGER TO USE ...................................................................118REPORT TRIGGER ORDER OF EXECUTION........................................................119GROUP FILTER .................................................................................................121FORMULA ........................................................................................................ 122

VALIDATION TRIGGER ....................................................................................124FORMAT TRIGGER ........................................................................................... 125ACTION TRIGGER ............................................................................................128REF CURSOR QUERY ........................................................................................ 129AFTERPARAMETER FORM TRIGGER............................................................... 131AFTERREPORT TRIGGER .................................................................................132BEFORE PARAMETER FORM TRIGGER ............................................................. 133BEFORE REPORT TRIGGER ...............................................................................134BETWEEN PAGES TRIGGER..............................................................................135

PROPERTIES........................................................................................................137ORACLE8 USAGE NOTES .................................................................................138ABOUT THE PROPERTY PALETTE....................................................................140ANCHOR PROPERTIES ..................................................................................... 144CHILD EDGE PERCENT ...................................................................................146CHILD EDGE TYPE .......................................................................................... 147CHILD OBJECTNAME ..................................................................................... 148COLLAPSE HORIZONTALLY ............................................................................ 149COLLAPSE VERTICALLY ..................................................................................150PARENT EDGE PERCENT .................................................................................152PARENT EDGE TYPE........................................................................................ 153PARENT OBJECTNAME ..................................................................................154BOILERPLATE PROPERTIES ..............................................................................155CONTAINS HTML TAGS ................................................................................156MINIMUM WIDOW LINES ...............................................................................157SOURCE FILE FORMAT ....................................................................................158

SOURCE FILENAME ......................................................................................... 159TYPE ................................................................................................................160LINE STRETCH WITH FRAME .......................................................................... 161BUTTON PROPERTIES ....................................................................................... 163LABEL TYPE..................................................................................................... 165TEXT................................................................................................................166ICON NAME .................................................................................................... 167TYPE ................................................................................................................168MULTIMEDIA FILE .......................................................................................... 169MULTIMEDIA FILE TYPE .................................................................................170MULTIMEDIA COLUMN ..................................................................................171MULTIMEDIA COLUMN TYPE......................................................................... 172PL/SQL T RIGGER .......................................................................................... 173CHART PROPERTIES ......................................................................................... 174CHART FILENAME ........................................................................................... 176CHART HYPERLINK ........................................................................................ 177CHART PARAMETERS AND COLUMNS PROPERTIES .......................................178CHART PARAMETER ....................................................................................... 179REPORT COLUMN (FOR CHART PARAMETER) ............................................... 180CHART QUERY ................................................................................................181REPORT GROUP ...............................................................................................182


6/593

Report Builder Referencevi

CHART COLUMN ............................................................................................183REPORT COLUMN (FOR CHART COLUMN ) ....................................................184COMMON COLUMN PROPERTIES ....................................................................185BREAK ORDER.................................................................................................186COLUMN TYPE................................................................................................188COMMENT ....................................................................................................... 189

DATABASE COLUMN NAME ........................................................................... 190DATATYPE ....................................................................................................... 191FILE FORMAT ..................................................................................................192NAME ..............................................................................................................193READ FROM FILE.............................................................................................194VALUE IF NULL...............................................................................................196WIDTH.............................................................................................................197SET BREAK ORDER.......................................................................................... 198COMMON LAYOUT OBJECT PROPERTIES........................................................199COMMENTS ..................................................................................................... 201HORIZONTAL ELASTICITY..............................................................................202KEEP WITH ANCHORING OBJECT..................................................................204NAME ..............................................................................................................206PAGE BREAK AFTER........................................................................................ 208PAGE BREAK BEFORE...................................................................................... 209PAGE PROTECT ...............................................................................................210BASE PRINTING ON ........................................................................................ 212PRINT OBJECTON ........................................................................................... 213PRINTER CODE BEFORE ..................................................................................216PRINTER CODE AFTER....................................................................................217VERTICAL ELASTICITY....................................................................................218HYPERLINK ..................................................................................................... 222HYPERLINK DESTINATION ............................................................................. 223BOOKMARK ..................................................................................................... 224APPLICATION COMMAND LINE (PDF)..........................................................225

CONDITIONAL FORMATTING ......................................................................... 226DISPLAY NAME ...............................................................................................227ADDITIONAL HYPERLINK ATTRIBUTES.......................................................... 228DATABASE COLUMN PROPERTIES ..................................................................229FIELD PROPERTIES ........................................................................................... 230SOURCE DATATYPE ........................................................................................ 232FORMAT MASK ...............................................................................................233DATE AND TIME FORMAT MASK SYNTAX......................................................234NUMBER FORMAT MASK SYNTAX..................................................................236VISIBLE............................................................................................................240PAGE NUMBERING .......................................................................................... 242SOURCE ...........................................................................................................245FORMULA COLUMN PROPERTIES ....................................................................247FRAME PROPERTIES ......................................................................................... 248GROUP PROPERTIES......................................................................................... 249CHILD DIMENSION ......................................................................................... 250FILTER TYPE .................................................................................................... 251NAME ..............................................................................................................252COMMENT ....................................................................................................... 253NUMBER OF RECORDS ....................................................................................254PL/SQL F ILTER..............................................................................................255


7/593

Report Builder Reference vii

DATA LINK PROPERTIES .................................................................................256CHILD COLUMN .............................................................................................259CHILD QUERY .................................................................................................260CONDITION ..................................................................................................... 261PARENT COLUMN ........................................................................................... 262PARENT GROUP ..............................................................................................263

SQL CLAUSE................................................................................................... 264MATRIX PROPERTIES ....................................................................................... 265CROSSPRODUCT GROUP ................................................................................266HORIZONTAL REPEATING FRAME .................................................................268VERTICAL REPEATING FRAME........................................................................ 269DATABASE COLUMN OBJECT PROPERTIES.....................................................270OLE2 PROPERTIES .......................................................................................... 271PARAMETER PROPERTIES ................................................................................272SYSTEMPARAMETERS ..................................................................................... 273ADD................................................................................................................. 274COMMENT ....................................................................................................... 275DATATYPE ....................................................................................................... 276HIDE FIRSTCOLUMN ...................................................................................... 277INITIAL VALUE................................................................................................278INPUT MASK ................................................................................................... 279NAME ..............................................................................................................280REMOVE ..........................................................................................................281RESTRICTLIST TO PREDETERMINED VALUES................................................. 282SELECT STATEMENT /S TATIC VALUES......................................................... 283VALIDATION TRIGGER....................................................................................284VALUE .............................................................................................................285WIDTH.............................................................................................................286LIST OF VALUES ..............................................................................................287PARAMETER FORM BOILERPLATE PROPERTIES .............................................. 288NAME ..............................................................................................................289

TYPE ................................................................................................................290PARAMETER FORM FIELD PROPERTIES ........................................................... 291DATATYPE ....................................................................................................... 292NAME ..............................................................................................................293SOURCE ...........................................................................................................294PLACEHOLDER COLUMN PROPERTIES ............................................................ 295PL/SQL F ORMULA ........................................................................................ 297ALPHABETICAL LIST OF PROPERTIES .............................................................. 298QUERY PROPERTIES......................................................................................... 304COMMENT ....................................................................................................... 305EXTERNAL QUERY SOURCE FILE....................................................................306MAXIMUM ROWS TO FETCH ........................................................................... 307NAME ..............................................................................................................308SQL QUERY STATEMENT ...............................................................................309TYPE ................................................................................................................311DATABASE REF COLUMN PROPERTIES ........................................................... 312REPEATING FRAME PROPERTIES .....................................................................313COLUMN MODE..............................................................................................314HORIZ. SPACE BETWEEN FRAMES..................................................................315MAXIMUM RECORDS PER PAGE .....................................................................316MINIMUM WIDOW RECORDS ......................................................................... 317


8/593

Report Builder Referenceviii

PRINT DIRECTION ........................................................................................... 318SOURCE ...........................................................................................................320VERT. SPACE BETWEEN FRAMES....................................................................321REPORT PROPERTIES........................................................................................ 322UNIT OF MEASUREMENT ................................................................................324MAX. HORIZONTAL BODY PAGES .................................................................325

MAX. VERTICAL BODY PAGES ....................................................................... 326PANEL PRINT ORDER...................................................................................... 327DIRECTION ...................................................................................................... 328DISTRIBUTION.................................................................................................329PREVIEWERTITLE ........................................................................................... 330ROLE NAME .................................................................................................... 331WIDTH (PARAMETER FORM WINDOW ) .......................................................... 332HEIGHT (PARAMETER FORM WINDOW )......................................................... 333NUMBER OF PAGES ......................................................................................... 334PAGE NAVIGATION CONTROL TYPE.............................................................. 335PAGE NAVIGATION CONTROL VALUE .......................................................... 336BEFORE REPORT TYPE..................................................................................... 337BEFORE REPORT VALUE .................................................................................338AFTERREPORT TYPE....................................................................................... 339AFTERREPORT VALUE ...................................................................................340BEFORE PAGE TYPE......................................................................................... 341BEFORE PAGE VALUE ..................................................................................... 342AFTERPAGE TYPE .......................................................................................... 343AFTERPAGE VALUE ....................................................................................... 344BEFORE FORM TYPE........................................................................................ 345BEFORE FORM VALUE ..................................................................................... 346AFTERFORM TYPE.......................................................................................... 347AFTERFORM VALUE....................................................................................... 348DESIGN IN CHARACTER UNITS ......................................................................349USE PREVIEWERHINT LINE ........................................................................... 350

PREVIEWERHINT LINE TEXT.......................................................................... 351USE PREVIEWERSTATUS LINE ........................................................................ 352PREVIEWERSTATUS LINE TEXT......................................................................353INCLUDE BITMAPPED OBJECTS....................................................................... 354INCLUDE BORDERS ......................................................................................... 355DISABLEHOST MENU ITEM............................................................................ 356DISABLESPLIT SCREEN KEY........................................................................... 357DISABLEZOOM KEY ....................................................................................... 358START IN ZOOM ..............................................................................................359SUPPRESSPREVIEWERTITLE........................................................................... 360REF CURSOR QUERY PROPERTIES ....................................................................361PL/SQL S TATEMENT ..................................................................................... 362SECTION PROPERTIES ...................................................................................... 363DISTRIBUTION.................................................................................................364HEIGHT ...........................................................................................................365HORIZONTAL PANELS PER PAGE ...................................................................366ORIENTATION .................................................................................................367REPORT HEIGHT .............................................................................................368REPORT WIDTH ...............................................................................................369VERTICAL PANELS PER PAGE ......................................................................... 370WIDTH.............................................................................................................371


9/593

Report Builder Reference ix

SUMMARY COLUMN PROPERTIES ...................................................................372COMPUTE AT ..................................................................................................373FUNCTION ....................................................................................................... 376PRODUCT ORDER............................................................................................377RESETAT......................................................................................................... 381SOURCE ...........................................................................................................383

TEMPLATE PROPERTIES ...................................................................................384ALIGNMENT .................................................................................................... 386ALIGN SUMMARIES WITH FIELDS...................................................................387BACKGROUND COLOR....................................................................................388BETWEEN FIELD AND LABELS (HORIZONTAL ) .............................................. 389BETWEEN FRAME AND FIELDS (HORIZONTAL ) ............................................. 390BETWEEN FRAME AND FIELDS (VERTICAL) ...................................................391BETWEEN MASTER AND DETAIL (HORIZONTAL ) ..........................................392BETWEEN MASTER AND DETAIL (VERTICAL) ................................................ 393BETWEEN PAGE AND FRAMES (HORIZONTAL )..............................................394BETWEEN PAGE AND FRAMES (VERTICAL).................................................... 395BETWEEN SIBLING FRAMES (HORIZONTAL ) ..................................................396BETWEEN SIBLING FRAMES (VERTICAL) ........................................................397BORDERS ......................................................................................................... 398CHARACTER JUSTIFICATION ........................................................................... 399DASH ...............................................................................................................400DATE JUSTIFICATION ...................................................................................... 401EDGE FOREGROUND COLOR .......................................................................... 402EDGE BACKGROUND COLOR.......................................................................... 403EDGE PATTERN ...............................................................................................404FIELDS PER LINE .............................................................................................405FILL PATTERN .................................................................................................406FONT ...............................................................................................................407FOREGROUND COLOR ....................................................................................408IMAGE .............................................................................................................409

INTER-FIELD (HORIZONTAL ) ......................................................................... 410INTER-FIELD (VERTICAL) ...............................................................................411INTER-FRAME (HORIZONTAL ) ....................................................................... 412INTER-FRAME (VERTICAL) ............................................................................. 413 JUSTIFY............................................................................................................414NUMBER JUSTIFICATION .................................................................................415PLACE LABELSABOVEFIELDS........................................................................ 416POSITION ......................................................................................................... 417STYLE...............................................................................................................418TEXT................................................................................................................419TEXTCOLOR ................................................................................................... 420USE VERTICAL SPACING .................................................................................421

EXECUTABLES....................................................................................................423EXECUTABLE NAMES....................................................................................... 424EXECUTABLE INVOCATION ............................................................................. 425HELP ON COMMAND LINE OPTIONS ............................................................... 426KEYWORD USAGE............................................................................................428DATABASE LOGIN ........................................................................................... 429EXPLICIT LOGIN ..............................................................................................430USERID..........................................................................................................431AUTOMATIC LOGIN ........................................................................................ 432


10/593

Report Builder Referencex

REMOTE LOGIN ...............................................................................................433RWBLD60 ...................................................................................................... 434RWBLD60 COMMAND LINE ARGUMENTS ...................................................435MODULE|REPORT (RWBLD60)............................................................... 437PARAMFORM (RWBLD60)........................................................................ 438CMDFILE (RWBLD60).................................................................................439

ARRAYSIZE (RWBLD60)............................................................................ 440DESTYPE (RWBLD60) .................................................................................441DESNAME (RWBLD60) ..............................................................................442DESFORMAT (RWBLD60)..........................................................................443COPIES (RWBLD60) ....................................................................................444CACHELOB (RWBLD60) ............................................................................ 445CURRENCY (RWBLD60) ............................................................................ 446THOUSANDS (RWBLD60)......................................................................... 447DECIMAL (RWBLD60)................................................................................448READONLY (RWBLD60)............................................................................449BUFFERS (RWBLD60) .................................................................................450PAGESIZE (RWBLD60) ...............................................................................451PROFILE (RWBLD60)..................................................................................452RUNDEBUG (RWBLD60)............................................................................453ONSUCCESS (RWBLD60)........................................................................... 454ONFAILURE (RWBLD60)........................................................................... 455ERRFILE (RWBLD60) ..................................................................................456LONGCHUNK (RWBLD60) ....................................................................... 457ACCESS (RWBLD60) ...................................................................................458ORIENTATION (RWBLD60) ......................................................................459BACKGROUND (RWBLD60) .....................................................................460MODE (RWBLD60) ...................................................................................... 461PRINTJOB (RWBLD60)................................................................................462TRACEFILE (RWBLD60).............................................................................463TRACEMODE (RWBLD60).........................................................................464

TRACEOPTS (RWBLD60) ........................................................................... 465AUTOCOMMIT (RWBLD60)...................................................................... 466NONBLOCKSQL (RWBLD60)....................................................................467ROLE (RWBLD60)........................................................................................ 468BLANKPAGES (RWBLD60) ....................................................................... 469MAXIMIZE (RWBLD60)..............................................................................470DISABLEPRINT (RWBLD60)...................................................................... 471DISABLEMAIL (RWBLD60) ....................................................................... 472DISABLEFILE (RWBLD60) ......................................................................... 473DISABLENEW (RWBLD60)........................................................................ 474DELIMITER (RWBLD60)............................................................................. 475CELLWRAPPER (RWBLD60)..................................................................... 476DATEFORMATMASK (RWBLD60)...........................................................477NUMBERFORMATMASK (RWBLD60)....................................................478DESTINATION (RWBLD60)....................................................................... 479DISTRIBUTE (RWBLD60) ........................................................................... 480PAGESTREAM (RWBLD60) ....................................................................... 481EXPRESS_SERVER (RWBLD60)................................................................. 482 (RWBLD60)..................................................................................484RWCGI60....................................................................................................... 485RWCLI60........................................................................................................486


11/593

Report Builder Reference xi

RWCLI60 COMMAND LINE ARGUMENTS ....................................................487PARAMFORM (RWCLI60) ......................................................................... 489DESTYPE (RWCLI60) ..................................................................................490BATCH (RWCLI60)......................................................................................491BACKGROUND (RWCLI60).......................................................................492SERVER (RWCLI60).....................................................................................493

JOBNAME (RWCLI60) ......... ........... .......... ........... .......... ........... .......... ........ 494SCHEDULE (RWCLI60) ..............................................................................495TOLERANCE (RWCLI60) ........................................................................... 496RWCON60..................................................................................................... 497RWCON60 C OMMAND LINE ARGUMENTS ..................................................498STYPE (RWCON60) ..................................................................................... 499SOURCE (RWCON60) .................................................................................500DTYPE (RWCON60) ....................................................................................501DEST (RWCON60) ....................................................................................... 502CMDFILE (RWCON60) ...............................................................................503LOGFILE (RWCON60) ................................................................................504OVERWRITE (RWCON60) ......................................................................... 505BATCH (RWCON60) ...................................................................................506DUNIT (RWCON60) ....................................................................................507PAGESIZE (RWCON60)..............................................................................508FORMSIZE (RWCON60) ............................................................................. 509RWMTS60......................................................................................................510RWRQM60..................................................................................................... 511RWRQV60...................................................................................................... 512RWOWS60..................................................................................................... 513RWRBE60....................................................................................................... 514RWRUN60 ..................................................................................................... 515RWRUN60 C OMMAND LINE ARGUMENTS ..................................................516MODULE|REPORT (RWRUN60)..............................................................518PARAMFORM (RWRUN60).......................................................................519

CMDFILE (RWRUN60) ...............................................................................520TERM (RWRUN60) ...................................................................................... 521ARRAYSIZE (RWRUN60)...........................................................................522DESTYPE (RWRUN60)...............................................................................523DESNAME (RWRUN60) ............................................................................. 524DESFORMAT (RWRUN60).........................................................................525COPIES (RWRUN60) ...................................................................................526CACHELOB (RWRUN60) ........................................................................... 527CURRENCY (RWRUN60) ........................................................................... 528THOUSANDS (RWRUN60)........................................................................ 529DECIMAL (RWRUN60)...............................................................................530READONLY (RWRUN60)...........................................................................531LOGFILE (RWRUN60)................................................................................. 532BUFFERS (RWRUN60) ................................................................................533BATCH (RWRUN60) ...................................................................................534PAGESIZE (RWRUN60) ..............................................................................535PROFILE (RWRUN60).................................................................................536RUNDEBUG (RWRUN60) .......................................................................... 537ONSUCCESS (RWRUN60).......................................................................... 538ONFAILURE (RWRUN60).......................................................................... 539KEYIN (RWRUN60)..................................................................................... 540


12/593

Report Builder Referencexii

KEYOUT (RWRUN60).................................................................................541ERRFILE (RWRUN60) .................................................................................542LONGCHUNK (RWRUN60) ......................................................................543ORIENTATION (RWRUN60).....................................................................544BACKGROUND (RWRUN60) ....................................................................545MODE (RWRUN60) ..................................................................................... 546

PRINTJOB (RWRUN60)............................................................................... 547TRACEFILE (RWRUN60)............................................................................ 548TRACEMODE (RWRUN60)........................................................................549TRACEOPTS (RWRUN60) .......................................................................... 550AUTOCOMMIT (RWRUN60)..................................................................... 551NONBLOCKSQL (RWRUN60)................................................................... 552ROLE (RWRUN60).......................................................................................553BLANKPAGES (RWRUN60) ......................................................................554YES (RWRUN60) .......................................................................................... 555DISABLEPRINT (RWRUN60)..................................................................... 556DISABLEMAIL (RWRUN60)......................................................................557DISABLEFILE (RWRUN60) ........................................................................ 558DISABLENEW (RWRUN60)....................................................................... 559DESTINATION (RWRUN60)...................................................................... 560DISTRIBUTE (RWRUN60) .......................................................................... 561DELIMITER (RWRUN60)............................................................................ 562CELLWRAPPER (RWRUN60).................................................................... 563DATEFORMATMASK (RWRUN60) ......................................................... 564NUMBERFORMATMASK (RWRUN60)................................................... 565PAGESTREAM (RWRUN60) .....................................................................566EXPRESS_SERVER (RWRUN60)................................................................ 567 (RWRUN60).................................................................................569


13/593

Report Builder Reference xiii

Send Us Your CommentsOracle Developer Report Builder Reference

Part No. A66598-01

Oracle Corporation welcomes your comments and suggestions onthe quality and usefulness of this publication. Your input is animportant 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 [email protected]. Please indicate the part number, section, andpage number (if available).


14/593

Report Builder Referencexiv


15/593

Report Builder Reference xv

PrefaceWelcome to Release 6.0 of the Oracle Developer Report Builder Reference.

This reference guide includes information to help you effectivelywork with Oracle Developer Report Builder and contains detailedinformation about the following:• Built ins• Triggers• Properties• ExecutablesThis preface explains how this reference is organized and introducesother sources of information that can help you use Oracle DeveloperReport Builder.


16/593

Report Builder Referencexvi

PrerequisitesYou should be familiar with your computer and its operating system.For example, you should know the commands for deleting andcopying files and understand the concepts of search paths,

subdirectories, and path names. Refer to your Microsoft Windows 95or NT and DOS product documentation for more information.

You should also understand the fundamentals of MicrosoftWindows, such as the elements of an application window. Youshould also be familiar with such programs as the Explorer, Taskbaror Task Manager, and Registry.

Notational ConventionsThe following typographical conventions are used in this guide:

Convention Meaning

fixed-width font Text in a fixed-width font indicates commandsthat you enter exactly as shown. Text typed on aPC is not case-sensitive unless otherwise noted.

In commands, punctuation other than bracketsand vertical bars must be entered exactly asshown.

lowercase Lowercase characters in a command statementrepresent a variable. Substitute an appropriatevalue.

UPPERCASE Uppercase characters within the text representcommand 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 promptmay differ.

Related PublicationsYou may also wish to consult the following Oracle documentation:

Title Part Number

Oracle Developer: Guidelines for BuildingApplications

A58766

SQL*Plus User's Guide and Reference Version 3.1 A24801


17/593

Report Builder Reference 1

Built-Ins


18/593

Report Builder Reference2

Built-in packages

Oracle provides several packaged procedures which you can use when building or debuggingyour PL/SQL-based applications.

Your PL/SQL code can make use of the procedures, functions, and exceptions in the followingclient-side built-in packages:• Oracle Developer built-in packages• SRW built-in packages


19/593


SRW.SET_ATTR attributes

ACTION

AFTCODE

AFTFORM_ESCAPE

AFTPAGE_ESCAPE

AFTREPORT_ESCAPE

BBCOLOR

BEFCODE

BEFFORM_ESCAPE

BEFPAGE_ESCAPE

BEFREPORT_ESCAPE

BFCOLORBOOKMARK

BORDERWIDTH

BORDPATT

FACE

FBCOLOR

FFCOLOR

FILLPATT

FORMATMASK

GCOLOR

GSPACING

HJUST

HYPERLINK

LINKTAG

PRINTER_INTRAY

STYLE

SZ

TEXT

WEIGHT


20/593


21/593


AFTCODE

New Feature: It is now more convenient to set this attribute using theSRW.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, simplifiedprocedure.

Description Is a reference to the printer escape sequence to be executed after each line of theobject. The printer escape sequence is inserted after the object is triggered to print but before ithas 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 Builderprinter escape sequence or a printer escape sequence that you created.


22/593


AFTFORM_ESCAPE

New Feature: It is now more convenient to set this attribute using theSRW.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, simplifiedprocedure.

Description Is any text, graphics, or HTML commands that you want to appear at the bottom ofthe HTML Parameter Form. This attribute is useful for placing a logo or some standard links onthe Parameter Form .

Values

You must specify two items for this attribute:

n AFTFORM_ESCAPE_TYPE can be set to either SRW.FILE_ESCAPE or SRW.TEXT_ESCAPE.n 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, theFile searching method is used to find it.


23/593


AFTPAGE_ESCAPE

New Feature: It is now more convenient to set this attribute using theSRW.SET_AFTER_PAGE_HTML procedure. Setting this attribute via SRW.SET_ATTR is still


Description Is any text, graphics, or HTML commands that you want to appear at the end ofpages of your document. This attribute is useful for placing a logo or some standard links at theend of each page in an HTML document.

Values


n AFTPAGE_ESCAPE_TYPE can be set to either SRW.FILE_ESCAPE or SRW.TEXT_ESCAPE.n 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, theFile searching method is used to find it.

AFTPAGE_ESCAPE restrictions

n When you specify SRW.SET_ATTR for this attribute you must use SRW.REPORT_ID as theobject_id:

SRW.SET_ATTR(SRW.REPORT_ID, SRW.ATTR);

n The default HTML included at the end of a page is shown below. It is not required unlessyou want the default separator line to appear between pages.

n If you want the AFTPAGE_ESCAPE to apply to every page of the report, you should specifyit in a trigger that fires before the report begins formatting, such as the Before Report trigger.

n If you want the AFTPAGE_ESCAPE to apply only to the current page, you should specify itin a format trigger for an object on that page.

Graphic page separator exampleNote: This example illustrates using SRW.SET_ATTR to set the AFTPAGE_ESCAPE attribute. Itis now more convenient to set this attribute using the SRW.SET_AFTER_PAGE_HTMLprocedure. Setting this attribute via SRW.SET_ATTR is still supported for compatibility, but it ishighly recommended that you use the new, simplified procedure.

/* The example below inserts a GIF file as a** page separator.*/function BeforeReport return boolean isbeginif ((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 := '' || '' || '
'; SRW.SET_ATTR(SRW.REPORT_ID, SRW.ATTR);end if;return (TRUE);end;


24/593


AFTREPORT_ESCAPE

New Feature: It is now more convenient to set this attribute using theSRW.SET_AFTER_REPORT_HTML procedure. Setting this attribute via SRW.SET_ATTR is still


Description Is any text, graphics, or HTML commands that you want to appear at the end ofyour document. This attribute is useful for placing a logo or some standard links at the end of anHTML document.

Values


n AFTREPORT_ESCAPE_TYPE can be set to either SRW.FILE_ESCAPE orSRW.TEXT_ESCAPE.

n AFTREPORT_ESCAPE_VALUE can be a filename or a text string containing valid HTMLdepending 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



n The default HTML included at the end of a report is shown below. If you useAFTREPORT_ESCAPE to replace this text, you must ensure that it contains the equivalentHTML commands.

n AFTREPORT_ESCAPE should be set in a trigger that fires before the report is doneformatting, such as the Before Report trigger.

Links to home pages exampleNote: 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_HTMLprocedure. Setting this attribute via SRW.SET_ATTR is still supported for compatibility, but it ishighly 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 isbeginif ((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 := '' || '' || 'Oracle Corporation -' || chr(10) || '' || 'Netscape ' || ' '; SRW.SET_ATTR(SRW.REPORT_ID, SRW.ATTR);end if;


25/593


return (TRUE);end;


26/593


BBCOLOR

New Feature: It is now more convenient to set this attribute using theSRW.SET_BACKGROUND_BORDER_COLOR procedure. Setting this attribute via

SRW.SET_ATTR is still supported for compatibility, but it is highly recommended that you usethe new, simplified procedure.

Description Is the background border color of the object. This attribute is ignored in charactermode.

Values

A valid color name.


27/593


28/593


BEFFORM_ESCAPE

New Feature: It is now more convenient to set this attribute using theSRW.SET_BEFORE_FORM_HTML procedure. Setting this attribute via SRW.SET_ATTR is still


Description Is any text, graphics, or HTML commands that you want to appear at the top of theHTML Parameter Form. This attribute is useful for placing a logo or some standard links on theParameter Form .

Values


n BEFFORM_ESCAPE_TYPE can be set to either SRW.FILE_ESCAPE or SRW.TEXT_ESCAPE.n BEFFORM_ESCAPE_VALUE can be a filename or a text string containing valid HTML

depending upon what you specified for BEFFORM_ESCAPE_TYPE. If you specify a file, theFile searching method is used to find it.


29/593


BEFPAGE_ESCAPE

New Feature: It is now more convenient to set this attribute using theSRW.SET_BEFORE_PAGE_HTML procedure. Setting this attribute via SRW.SET_ATTR is still


Description Is any text, graphics, or HTML commands that you want to appear at the beginningof pages of your document. This attribute is useful for placing a logo or some standard links atthe beginning of each page in an HTML document.

Values


n BEFPAGE_ESCAPE_TYPE can be set to either SRW.FILE_ESCAPE or SRW.TEXT_ESCAPE.n BEFPAGE_ESCAPE_VALUE can be a filename or a text string containing valid HTML

depending upon what you specified for BEFPAGE_ESCAPE_TYPE. If you specify a file, theFile searching method is used to find it.

BEFPAGE_ESCAPE restrictions



n If you want the BEFPAGE_ESCAPE to apply to every page of the report, you should specifyit in a trigger that fires before the report begins formatting, such as the Before Report trigger.

n If you want the BEFPAGE_ESCAPE to apply only to the current page, you should specify itin a format trigger for an object on that page.

Before and after page escape exampleNote: This example illustrates using SRW.SET_ATTR to set the BEFPAGE_ESCAPE andAFTPAGE_ESCAPE attributes. It is now more convenient to set these attributes using theSRW.SET_BEFORE_PAGE_HTML and SRW.SET_AFTER_PAGE_HTML procedures. Settingthis attribute via SRW.SET_ATTR is still supported for compatibility, but it is highlyrecommended that you use the new, simplified procedure.

/* The example below centers the document in** the browser .*/function BeforeReport return boolean isbeginif ((upper(:MODE) != 'CHARACTER') and (upper(:DESFORMAT) = 'HTML')) then SRW.ATTR.MASK := SRW.BEFPAGE_ESCAPE_ATTR + SRW.AFTPAGE_ESCAPE_ATTR; SRW.ATTR.BEFPAGE_ESCAPE_TYPE := SRW.TEXT_ESCAPE; SRW.ATTR.BEFPAGE_ESCAPE_VALUE := ''; SRW.ATTR.AFTPAGE_ESCAPE_TYPE := SRW.TEXT_ESCAPE; SRW.ATTR.AFTPAGE_ESCAPE_VALUE := ''; SRW.SET_ATTR(SRW.REPORT_ID, SRW.ATTR);end if;return (TRUE);end;


30/593


BEFREPORT_ESCAPE

New Feature: It is now more convenient to set this attribute using theSRW.SET_BEFORE_REPORT_HTML and SRW.SET_AFTER_REPORT_HTML procedures.

Setting this attribute via SRW.SET_ATTR is still supported for compatibility, but it is highlyrecommended that you use the new, simplified procedure.

Description Is any text, graphics, or HTML commands that you want to appear at the beginningof your document. This attribute is useful for placing a logo or some standard links at thebeginning of an HTML document.

Values


n BEFREPORT_ESCAPE_TYPE can be set to either SRW.FILE_ESCAPE orSRW.TEXT_ESCAPE.

n BEFREPORT_ESCAPE_VALUE can be a filename or a text string containing valid HTMLdepending upon what you specified for BEFREPORT_ESCAPE_TYPE. If you specify a file,the File searching method is used to find it.

BEFREPORT_ESCAPE restrictions



n The default HTML included at the beginning of a report is shown below. If you useBEFREPORT_ESCAPE to replace this text, you must ensure that it contains the equivalentHTML 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 exampleNote: This example illustrates using SRW.SET_ATTR to set the BEFREPORT_ESCAPE andAFTREPORT_ESCAPE attributes. It is now more convenient to set these attributes using theSRW.SET_BEFORE_REPORT_HTML procedure. Setting this attribute via SRW.SET_ATTR is stillsupported for compatibility, but it is highly recommended that you use the new, simplifiedprocedure.

/* The example below sets both BEFREPORT_ESCAPE and** AFTREPORT_ESCAPE in the Before Report trigger.** The 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 isbeginif ((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 := 'logo.htm'; SRW.ATTR.AFTREPORT_ESCAPE_TYPE := SRW.TEXT_ESCAPE; SRW.ATTR.AFTREPORT_ESCAPE_VALUE := '' ||


31/593


' Questions? - ' || '' || '[email protected]' || '' || ''; SRW.SET_ATTR(SRW.REPORT_ID, SRW.ATTR);end if;return (TRUE);end;


32/593


BFCOLOR

New Feature: It is now more convenient to set this attribute using theSRW.SET_BACKGROUND_FILL_COLOR procedure. Setting this attribute via SRW.SET_ATTR

is still supported for compatibility, but it is highly recommended that you use the new, simplifiedprocedure.

Description Is the background fill color of the object. This attribute is ignored in character mode.

Values

A valid color name.


33/593


34/593


srw.set_attr(0,srw.attr); return (TRUE);end;

Dynamic BOOKMARK exampleNote: This example illustrates using SRW.SET ATTR to set the BOOKMARK attribute. It is nowmore convenient to set this attribute using the SRW.SET_BOOKMARK procedure. Setting thisattribute via SRW.SET_ATTR is still supported for compatibility, but it is highly recommendedthat you use the new, simplified procedure.

/* The format trigger below defines a bookmark for** the boilerplate object B_2. Notice that the name** of the bookmark is dynamic. CATEGORY is a column** value that is concatenated with the string Expense** Summary Section for each execution of the format** trigger. In this case, CATEGORY could contain** ordering information (e.g., 1#) or perhaps a string** that makes the bookmark unique within the report.*/function B_2FormatTrigger return boolean isbegin srw.attr.mask := srw.BOOKMARK_ATTR; srw.attr.bookmark := :category || ' Expense Summary Section'; srw.set_attr(0,srw.attr); return (TRUE);end;


35/593


BORDERWIDTH

New Feature: It is now more convenient to set this attribute using theSRW.SET_BORDER_WIDTH procedure. Setting this attribute via SRW.SET_ATTR is still


Description Is the border width of the object.

Values

0 Means no border.

any positiveinteger

Means a border width of that many picas for a bit-mappedreport or one character for a character mode report.


36/593


BORDPATT

New Feature: It is now more convenient to set this attribute using theSRW.SET_BORDER_PATTERN procedure. Setting this attribute via SRW.SET_ATTR is still


Description Is the fill pattern for the border of the object. This attribute is ignored in charactermode.

Values

A valid pattern name.


37/593


FACE

New Feature: It is now more convenient to set this attribute using the SRW.SET_FONT_FACEprocedure. 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 font face of a CHAR, DATE, or NUMBER field. This attribute is ignored incharacter mode.

Values

A valid font name on the machine where the report is run.


38/593


FBCOLOR

New Feature: It is now more convenient to set this attribute using theSRW.SET_FOREGROUND_BORDER_COLOR procedure. Setting this attribute via

SRW.SET_ATTR is still supported for compatibility, but it is highly recommended that you usethe new, simplified procedure.

Description Is the foreground border color of the object. This attribute is ignored in charactermode.

Values

A valid color name.


39/593


FFCOLOR

New Feature: It is now more convenient to set this attribute using theSRW.SET_FOREGROUND_FILL_COLOR procedure. Setting this attribute via SRW.SET_ATTR

is still supported for compatibility, but it is highly recommended that you use the new, simplifiedprocedure.

Description Is the foreground fill color of the object. This attribute is ignored in character mode.

Values

A valid color name.


40/593


FILLPATT

New Feature: It is now more convenient to set this attribute using the SRW.SET_FILL_PATTERNprocedure. 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 fill pattern of the object. This attribute is ignored in character mode.

Values

A valid pattern name.


41/593


FORMATMASK

New Feature: It is now more convenient to set this attribute using theSRW.SET_FORMAT_MASK procedure. Setting this attribute via SRW.SET_ATTR is still


Description Is the format mask for the DATE, or NUMBER field.

Values

Any valid format mask.


42/593


GCOLOR

New Feature: It is now more convenient to set this attribute using the SRW.SET_TEXT_COLORprocedure. 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 global text color of the CHAR, DATE, or NUMBER field. This attribute isignored in character mode.

Values

A valid color name.


43/593


GSPACING

New Feature: It is now more convenient to set this attribute using theSRW.SET_CUSTOM_SPACING or SRW.SET_SPACING procedures. Setting this attribute via

SRW.SET_ATTR is still supported for compatibility, but it is highly recommended that you usethe new, simplified procedures.

Description Is the global text leading for a CHAR, DATE, or NUMBER field, or boilerplate text.This attribute is ignored in character mode.

Values

srw.single_spacing

srw.onehlf_spacing

srw.double_spacing

srw.custom_spacing Specifies the spacing in VGS units, which are very small. If you usesrw.custom_spacing, then you specify the custom number of VGS unitsusing srw.attr.custom. For example:

srw.attr.mask := SRW.GSPACING_ATTR; srw.attr.gspacing := SRW.CUSTOM_SPACING; srw.attr.custom := 200; srw.set_attr (0, srw.attr);


44/593


HJUST

New Feature: It is now more convenient to set this attribute using theSRW.SET_JUSTIFICATION procedure. Setting this attribute via SRW.SET_ATTR is still


Description Is the horizontal justification of the CHAR, DATE, or NUMBER field.

Values

srw.left_hjust

srw.center_hjust

srw.right_hjust

srw.flush_hjust Is ignored in bit-mapped reports.


45/593


HYPERLINK

New Feature: It is now more convenient to set this attribute using the SRW.SET_HYPERLINKprocedure. 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 URL Web link specification.

Note: An object that is the source of a Web link cannot also be associated with an action.

Values

A valid link:

To another document on the same machine (e.g., file:/private/mynewdoc.pdf orfile:///C|/temp/mynewdoc.pdf)

To another document on a different machine (e.g., http://www.newmach.com/newdoc.pdf)

To a destination within the current document (e.g., #my_dest_name)

To a destination within a local document (e.g., file:/private/somedoc.pdf#a_dest_name)To a destination within a remote document (e.g.,http://www.newmach.com/newdoc.pdf#some_dest_name)

To any URL (e.g., http://www.newmach.com/newdoc.html,ftp://www.reposit.com/filetoget.example, http://www.somemch.com/cgi-bin/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, the PDFviewer must be configured to work with a Web browser (e.g., configured as a helperapplication or installed as a plug-in to your Web browser).

HYPERLINK exampleNote: This example illustrates using SRW.SET_ATTR to set the HYPERLINK attribute. It is nowmore convenient to set this attribute using the SRW.SET_HYPERLINK procedure. Setting thisattribute via SRW.SET_ATTR is still supported for compatibility, but it is highly recommendedthat you use the new, simplified procedure.

/* The format trigger below defines a Web link** to a destination (mytarget) in another document** (newdoc.pdf) for the boilerplate object B_2.

** Note: If the target were in the same document,** you would omit http://www.newmach.com/newdoc.pdf.*/function B_2FormatTrigger return boolean isbegin srw.attr.mask := srw.HYPERLINK_ATTR; srw.attr.hyperlink := 'http://www.newmach.com/newdoc.pdf' || '#mytarget'; srw.set_attr(0,srw.attr); return (TRUE);end;


46/593


Dynamic HYPERLINK exampleNote: This example illustrates using SRW.SET_ATTR to set the HYPERLINK attribute. It is nowmore convenient to set this attribute using the SRW.SET_HYPERLINK procedure. Setting thisattribute via SRW.SET_ATTR is still supported for compatibility, but it is highly recommendedthat you use the new, simplified procedure.

/* The format trigger below defines a Web link** for the boilerplate object B_3. Notice how the** destination of the link is determined dynamically** based upon the values of SRCDIR and CF_PICKVIDEO.** For example, if the value of SRCDIR were** http://www.newmach.com and CF_PICKVIDEO were good.avi,** this function would assign the following Web** link to the object:** http://www.newmach.com/webdemo/src/good.avi.*/function B_3FormatTrigger return boolean isbegin srw.attr.mask := srw.HYPERLINK_ATTR; srw.attr.hyperlink := :srcdir||:cf_pickvideo; if ( upper(:cf_pickvideo) like '%GOOD%' ) then srw.attr.mask := srw.attr.mask + srw.FBCOLOR_ATTR + srw.BBCOLOR_ATTR; srw.attr.fbcolor := 'green'; srw.attr.bbcolor := 'green'; end if; srw.set_attr(0,srw.attr); return (TRUE);end;/* SRCDIR is a parameter whose value is determined at** runtime by the following After Parameter Form trigger*/function AfterPForm return boolean isbegin :srcdir := :web_server || '/webdemo/src/'; :docsdir := :web_server || '/webdemo/docs/ '; return (TRUE);end;/* CF_PICKVIDEO is a formula column whose value is** determined by the following function*/function CF_pickvideoFormula return Char isbegin if ( :avg_h_div < .80 ) then return ('bad.avi'); else return ('good.avi'); end if;end;


47/593


LINKTAG

New Feature: It is now more convenient to set this attribute using the SRW.SET_LINKTAGprocedure. 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 an object's identifier and can be used as the destination in Web links.

Values

A valid, unique name that only makes use of the 26 upper or lower case US ASCII letters,numbers, or underscore characters. Other special characters will automatically be converted tounderscore characters.

LINKTAG restrictions

n LINKTAG should only be set in the following triggers:

Format

LINKTAG exampleNote: This example illustrates using SRW.SET_ATTR to set the LINKTAG attribute. It is nowmore convenient to set this attribute using the SRW.SET_LINKTAG procedure. Setting thisattribute via SRW.SET_ATTR is still supported for compatibility, but it is highly recommendedthat you use the new, simplified procedure.

/* The format trigger below assigns an identifier** (mytarget) to the boilerplate object B_500.** This means that the object can now be the destination** of a Web link.*/function B_500FormatTrigger return boolean isbegin srw.attr.mask := SRW.LINKTAG_ATTR;

srw.attr.linktag := 'mytarget'; srw.set_attr(0, SRW.ATTR); return (TRUE);end;

Dynamic LINKTAG exampleNote: This example illustrates using SRW.SET_ATTR to set the LINKTAG attribute. It is nowmore convenient to set this attribute using the SRW.SET_LINKTAG procedure. Setting thisattribute via SRW.SET_ATTR is still supported for compatibility, but it is highly recommendedthat you use the new, simplified procedure.

/* 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). This function ensures that a unique

** identifier is assigned to each instance of F_Dept.*/function F_DeptFormatTrigger return boolean isbegin srw.attr.mask := SRW.LINKTAG_ATTR; srw.attr.linktag := 'dept_details_' || LTRIM(TO_CHAR(:deptno)); srw.set_attr(0, SRW.ATTR); return (TRUE);end;


48/593


PRINTER_INTRAY

New Feature: It is now more convenient to set this attribute using theSRW.SET_PRINTER_TRAY procedure. Setting this attribute via SRW.SET_ATTR is still


Description Is the name of a valid printer tray and can be used switch to different printer traysas your report formats.

Values

A valid, unique name as defined for your printer in the Page Setup dialog.

PRINTER_INTRAY restrictions

n PRINTER_INTRAY should only be set in the following triggers:

Between Pages

Before Report

Format

PRINTER_INTRAY exampleNote: This example illustrates using SRW.SET_ATTR to set the PRINTER_INTRAY attribute. It isnow more convenient to set this attribute using the SRW.SET_PRINTER_TRAY procedure.Setting this attribute via SRW.SET_ATTR is still supported for compatibility, but it is highlyrecommended that you use the new, simplified procedure.

/* The example below sets the printer tray in the Between Pages trigger.*/function BetweenPages return boolean isbegin srw.attr.mask := SRW.PRINTER_INTRAY_ATTR; srw.attr.printer_intray := 'letterhead'; srw.set_attr(SRW.REPORT_ID, srw.attr);return (TRUE);end;


49/593


STYLE

New Feature: It is now more convenient to set this attribute using the SRW.SET_FONT_STYLEprocedure. 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 font style of the CHAR, DATE, or NUMBER field. This attribute is ignored inbit-mapped reports.

Values

srw.plain_style

srw.italic_style

srw.oblique_style

srw.underline_style

srw.outline_style

srw.shadow_stylesrw.inverted_style

srw.overstrike_style

srw.blink_style


50/593


SZ

New Feature: It is now more convenient to set this attribute using the SRW.SET_FONT_SIZEprocedure. 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 font size of the CHAR, DATE, or NUMBER field. This attribute is ignored incharacter mode.

Values

A valid size for the named font on the machine where the report will run.


51/593


TEXT

New Feature: It is now more convenient to set this attribute using theSRW.SET_CHARMODE_TEXT procedure. Setting this attribute via SRW.SET_ATTR is still


Description Is the character mode text characteristic for the CHAR, DATE, or NUMBER field.This attribute is ignored in bit-mapped reports.

Values

srw.plain_texta

srw.reverse_texta

srw.bold_texta

srw.reversebold_texta

srw.underline_texta

srw.underlinereverse_texta

srw.underlinebold_texta

srw.reverseboldunderline_texta


52/593


WEIGHT

New Feature: It is now more convenient to set this attribute using the SRW.SET_FONT_WEIGHTprocedure. 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 font weight of the CHAR, DATE, or NUMBER field. This attribute is ignoredin character mode.

Values

srw.ultralight_weight

srw.extralight_weight

srw.light_weight

srw.demilight_weight

srw.medium_weight

srw.demibold_weightsrw.bold_weight

srw.extrabold_weight


53/593


The Report Builder PL/SQL package (SRW)

To save you time, Report Builder is shipped with a package --i.e., a collection of PL/SQLconstructs--that contains many functions, procedures, and exceptions you can reference in any of

your libraries or reports. The name of Report Builder's package is SRW. As a result, any timeyou reference a construct in the SRW package, you must prefix it with SRW, for example,SRW.DO_SQL.

Note: You cannot reference constructs in the SRW package from another product, e.g., fromSQL*Plus.

Constructs found in a package are commonly referred to as "packaged"; i.e., packaged functions,packaged procedures, and packaged exceptions.


54/593


SRW.BREAK

Description This procedure temporarily stops report execution at the place at whichSRW.BREAK was encountered, and displays (read-only) the current values of all columns and

parameters. Report execution resumes when the read-only screen is accepted.Syntax

SRW.BREAK;

SRW.BREAK restrictions

n This procedure is not meaningful in a Before Form or After Form trigger, because data forthe report is not fetched until the Before Report trigger (which fires after the After Formtrigger).

n All column and parameter values are displayed in the read-only screen. No PL/SQLvariables, or any other object values are displayed.


55/593


SRW.CONTEXT_FAILURE

Description This exception stops the report execution and raises the following error message:REP-1426: Running from incorrect context.

SyntaxSRW.CONTEXT_FAILURE;

Usage Notes Report Builder raises this exception when a Report Builder packaged function orprocedure is called in the wrong context (see the chart below).

In this chart, NO means that the function or procedure cannot be called in that context; YESmeans it can.

Name ParameterForm

DataModel

FormatTrigger

ReportTrigger

srw.break NO YES YES NO

srw.do_sql YES YES YES YESsrw.geterr_run YES YES YES YES

srw.get_page_num NO NO YES NO

srw.message YES YES YES YES

srw.reference YES YES YES YES

srw.run_report YES YES YES YES

srw.set_attr NO NO YES NO

srw.set_field_char NO NO YES NO

srw.set_field_date NO NO YES NOsrw.set_field_num NO NO YES NO

srw.set_maxrow NO YES YES YES

srw.user_exit YES YES YES YES

SRW.CONTEXT_FAILURE example/* Suppose you want your own error message raised,** instead of the default error message.** You could handle this exception in the following way:*/

EXCEPTIONwhen SRW.CONTEXT_FAILURE then srw.message(4000, 'Contact the Application Development group regarding SRW.CONTEXT_FAILURE.'); rai

Oracle Developer Report Builder Reference

Documents