Home   Package List   Routine Alphabetical List   Global Alphabetical List   FileMan Files List   FileMan Sub-Files List   Package Component Lists   Package-Namespace Mapping  
Source Information |  Call Graph |  External References |  All
Print Page as PDF
Remote Procedure: ROR REPORT RETRIEVE

Package: Clinical Case Registries

Remote Procedure: ROR REPORT RETRIEVE


Source Information

Name Value
NAME ROR REPORT RETRIEVE
TAG GETXML
ROUTINE RORRP011
RETURN VALUE TYPE ARRAY
AVAILABILITY RESTRICTED
WORD WRAP ON TRUE
VERSION 1
DESCRIPTION
The ROR REPORT RETRIEVE remote procedure returns an array that contains
the report (in XML format) generated by the task.
INPUT PARAMETER
  1. INPUT PARAMETER:   TASK
    PARAMETER TYPE:   LITERAL
    REQUIRED:   YES
    SEQUENCE NUMBER:   1
    DESCRIPTION:   
    Task number returned either by the ROR REPORT SCHEDULE or ROR TASK LIST
    remote procedures.
    
  2. INPUT PARAMETER:   FROM
    PARAMETER TYPE:   LITERAL
    SEQUENCE NUMBER:   2
    DESCRIPTION:   
    A string that indicates where to start/continue the rendering process. It 
    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: 
    contains three "^"-pieces:
    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.
      ^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)
    
  3. INPUT PARAMETER:   MAXSIZE
    PARAMETER TYPE:   LITERAL
    SEQUENCE NUMBER:   3
    DESCRIPTION:   
    Either the maximum number of lines to retrieve or the maximum size of the
    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.
    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
    
  4. INPUT PARAMETER:   SORT
    PARAMETER TYPE:   LIST
    SEQUENCE NUMBER:   4
    DESCRIPTION:   
    The SORT list defines how the different parts of the report are sorted.
      <REPORT>
        <PATIENT>
          <NAME> ... </NAME>
          <DOB> ... </DOB>
          <SELRULES>
            <RULE>
              <NAME> ... </NAME>
              <DATE> ... </DATE>
            </RULE>
    It should be defined as follow:
            ...
          </SELRULES>
        </PATIENT>
        ...
      </REPORT>
    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.
      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:
    
RETURN PARAMETER DESCRIPTION
A negative value of the first "^"-piece of the Results[0] indicates that
  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.
an error occurred during the execution of the remote procedure. In this
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
case, the second piece of the Results[0] will contain number of the error
      for the FROM parameter is not returned in the Results[0]
      and the latter contains the first line of the report.
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

Call Graph

Call Graph

Call Graph Total: 1

Package Total Call Graph
Clinical Case Registries 1 GETXML^RORRP011  

External References

Name Field # of Occurrence
GETXML^RORRP011 1
Source Information |  Call Graph |  External References |  All