ROR REPORT RETRIEVE

TITLEVALUE
NAMEROR REPORT RETRIEVE
DESCRIPTIONThe ROR REPORT RETRIEVE remote procedure returns an array that contains
the report (in XML format) generated by the task.
TAGGETXML
ROUTINERORRP011
INPUT PARAMETERSSEQUENCE NUMBER1
INPUT PARAMETERTASK
DESCRIPTIONTask number returned either by the ROR REPORT SCHEDULE or ROR TASK LIST
remote procedures.
PARAMETER TYPELITERAL
REQUIREDYES
MAXIMUM DATA LENGTH
INPUT PARAMETERSSEQUENCE NUMBER2
INPUT PARAMETERFROM
DESCRIPTIONA string that indicates where to start/continue the rendering process. It
contains three "^"-pieces:

^1: IEN of the report element

^2: Where exactly the rendering process has stopped
(see the $$XMLREP^RORTSK10 function for details)

^3: IEN of the text line (if the 2nd piece = 3)

To continue the rendering from the point where it stopped during the
previous call of the remote procedure, just assign the non-empty value
returned in the RESULT[0] by the previous call.

By default (if $G(FROM)'>0), the rendering starts from the beginning of
the report.

NOTE:

Despite this description, you must not make any assumptions about
structure of this parameter (it can be changed at any time without
warning). The only exception is the IEN of the report element. You can
assign a positive value to this parameter before the call to start the
rendering from the corresponding element.
PARAMETER TYPELITERAL
REQUIRED
MAXIMUM DATA LENGTH
INPUT PARAMETERSSEQUENCE NUMBER3
INPUT PARAMETERMAXSIZE
DESCRIPTIONEither the maximum number of lines to retrieve or the maximum size of the
output in bytes (append the "B" to the number). By default (if
$G(MAXSIZE)'>0,) the whole report (starting from the point indicated by
the FROM parameter if it is defined) is retrieved.

Examples:
500 Retrieve no more that 500 lines
4096B Retrieve no mor than 4Kb

NOTE: If the "B" suffix is used, the size of the retrieved
portion of the document can be somewhat bigger than
MAXSIZE! The last line of the chunk is not truncated
even if the size will be bigger than MAXSIZE.
PARAMETER TYPELITERAL
REQUIRED
MAXIMUM DATA LENGTH
INPUT PARAMETERSSEQUENCE NUMBER4
INPUT PARAMETERSORT
DESCRIPTIONThe SORT list defines how the different parts of the report are sorted.
It should be defined as follow:

SORT(i)="ParentElementName=SortElementName"

An optional D[ESC] modifier (the abbreviation of 'descending') can be
added after the SortElementName. They should be sepearted by the ':'.

For example, if the report has the following structure:



...
...


...
...

...


...


and the SORT parameter is defined by the client application as follow:

with RPCBroker do begin
Param[3].PType := list;
Param[3].Mult[1] := 'REPORT=NAME';
Param[3].Mult[2] := 'SELRULES=DATE:D';
end;

then the procedure will sort the patients by their names and the selection
rules for each patient will be sorted by the corresponding dates in
descending order.
PARAMETER TYPELIST
REQUIRED
MAXIMUM DATA LENGTH
RETURN VALUE TYPEARRAY
RETURN PARAMETER DESCRIPTIONA negative value of the first "^"-piece of the Results[0] indicates that
an error occurred during the execution of the remote procedure. In this
case, the second piece of the Results[0] will contain number of the error
descriptors returned in the subsequent nodes of the Results array:

Results[0] Result Descriptor
^01: The last error code
^02: Number of the error descriptors

Results[i] Error Descriptor
^01: Error code
^02: Message
^03: Place of the error

Otherwise, it contains either a string that indicates the place where
the rendering stopped because the maximum number of lines (defined by the
NUMBER parameter) had been processed or an empty string if the processing
of the report was completed.

You should pass this value (if it is not empty) as the FROM parameter to
subsequent call of the remote procedure if you want to continue the
rendering from the point where it stopped.

The subsequent elements of the resulting array (starting from 1) contain
the lines of the report. An element can contain an XML tag, a single-line
value between opening and closing tags or a line of text.

NOTE: If the MAXSIZE parameter is not defined or not greater
than zero (a request for the whole report), the new value
for the FROM parameter is not returned in the Results[0]
and the latter contains the first line of the report.
AVAILABILITYRESTRICTED
INACTIVE
CLIENT MANAGER
WORD WRAP ONTRUE
VERSION1
SUPPRESS RDV USER SETUP
APP PROXY ALLOWED