Copyright © TIBCO Software Inc. All Rights Reserved
Copyright © TIBCO Software Inc. All Rights Reserved


Chapter 3 Tools : $SETRPTATTRIBUTE

$SETRPTATTRIBUTE
Sets the attributes of the report that is to be printed. (C)
Invocation
CALL $SETRPTATTRIBUTE(report, attribute, value)
 
The name of the report to which the attributes are to be applied. Its syntax is C (fixed-length character string) with length 16.
IMMEDIATE – Does not sort the records of the report; just sends the records to the output as they are read. The corresponding entry in value must be Y.
OCCLIMIT – Limits the number of occurrences used by the Report Server to generate the report. The corresponding entry in value must be the maximum number of occurrences that can be inserted into the report.
PAGELENGTH – The physical page length. The entry in value specifies the size in number of lines.
PAGEWIDTH – The physical page width. The entry in value specifies the size in number of characters.
EJECT – Indicates whether a new page should be inserted between reports when more than one report is printed in a transaction. The entry for value should be either Y (new page should be inserted) or N (a new page should not be inserted).
PAGENUMBER – Specifies the start page number to be used if more than one report is printed in a transaction. If value is an empty string, it indicates that the page numbers are to run consecutively through all the reports. The entry in value overrides the default page numbering.
The setting to be applied for the attribute specified. Each value is discussed together with its corresponding attribute.
Usage Notes
Page formatting options (PAGELENGTH, PAGEWIDTH) must precede the call to $SETRPTMEDIUM, since they copy the current settings for the named report and do not refresh them until the report is printed.
If $SETRPTATTRIBUTE is being used with overlapping report output, the page length information can be ignored if value is lower than the previous report’s page length.
Use of $SETRPTMEDIUM is encouraged because it enables centralization of all current and future attributes in a single call syntax instead of their being distributed among several shareable tools.
Example
The following rule runs three occurrences of the test report RPTEST_1 starting at page 999 and sends it to the screen.

 
RPTEST_1;
_
_ ------------------------------------------------------------------------
_ ------------------------------------------------------------+-----------
_ FORALL $EMPLOYEES : | 1
_ FORALL EMPLOYEES (EMPLOYEES.REGION) : |
_ RPTEST_1$$$$$$$$4.* = EMPLOYEES.*; |
_ RPTEST_1$$$$$$$$4.* = $EMPLOYEES.*; |
_ INSERT RPTEST_1$$$$$$$$4('SETRPTATT'); |
_ END; |
_ END; |
_ CALL $SETRPTATTRIBUTE('RPTEST_1', 'PAGENUMBER', '999'); | 2
_ CALL $SETRPTATTRIBUTE('RPTEST_1', 'OCCLIMIT', '3'); | 3
_ CALL $SETRPTMEDIUM('RPTEST_1', 'VISUAL' 'SCR'); | 4
_ PRINT RPTEST_1; | 5
_ CALL ENDMSG(MESSAGE('@RPTGEN', 602, 'RPTEST_1', 'SCR' ''; | 6
_ ------------------------------------------------------------------------
_ ON LOGLIMIT :
_ CALL END MSG(MESSAGE('@RPTGEN', 698, ''));

 

Copyright © TIBCO Software Inc. All Rights Reserved
Copyright © TIBCO Software Inc. All Rights Reserved