STANDARD DATA DICTIONARY #799.34 -- ROR REPORT PARAMETERS FILE                                                    3/24/25    PAGE 1
STORED IN ^ROR(799.34,  (24 ENTRIES)   SITE: WWW.BMIRWIN.COM   UCI: VISTA,VISTA                                    (VERSION 1.5)   

DATA          NAME                  GLOBAL        DATA
ELEMENT       TITLE                 LOCATION      TYPE
-----------------------------------------------------------------------------------------------------------------------------------
The ROR REPORT PARAMETERS file stores the report definitions that are used by the ROR REPORT SCHEDULE remote procedure to schedule
the reports.  
 
Records of the file are uniquely identified by the report code (the "A" primary key and the uniqueness index "KEY" are used for
that purpose).  


              DD ACCESS: @
              RD ACCESS: @
              WR ACCESS: @
             DEL ACCESS: @
           LAYGO ACCESS: @
           AUDIT ACCESS: @

PRIMARY KEY:        A (#41)
  Uniqueness Index: KEY (#372)
       File, Field: 1) CODE (799.34,.04)

POINTED TO BY: REPORT STATS field (#.01) of the REPORT STATS sub-field (#798.12) of the ROR REGISTRY PARAMETERS File (#798.1) 
               REPORT field (#.04) of the ROR TASK File (#798.8) 
               

CROSS
REFERENCED BY: NAME(B)

INDEXED BY:    CODE (KEY)




799.34,.01    NAME                   0;1 FREE TEXT (Required)

              INPUT TRANSFORM:  Q:$$VAEDT^RORDD(799.34,$G(DA))  K:$L(X)>60!($L(X)<3)!'(X'?1P.E) X
              LAST EDITED:      NOV 26, 2002 
              HELP-PROMPT:      Enter the report name (3-60 characters). 
              DESCRIPTION:      YOU MUST NOT EDIT THIS FIELD IF IT IS PART OF A NATIONAL REGISTRY DEFINITION! 
                                 
                                The name of the report stored in the NAME field is displayed in the Reports sub-menu of the GUI.  

              DELETE TEST:      1,0)= I $$VADEL^RORDD(799.34,$G(DA))

              DELETE AUTHORITY: @
              WRITE AUTHORITY:  @
              NOTES:            XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER

              CROSS-REFERENCE:  799.34^B 
                                1)= S ^ROR(799.34,"B",$E(X,1,30),DA)=""
                                2)= K ^ROR(799.34,"B",$E(X,1,30),DA)
                                3)= Do not delete!


799.34,.02    BACKGROUND PROCESSING? 0;2 SET

                                '0' FOR NO; 
                                '1' FOR YES; 
              INPUT TRANSFORM:  Q:$$VAEDT^RORDD(799.34,$G(DA))
              LAST EDITED:      NOV 27, 2002 
              DESCRIPTION:      YOU MUST NOT EDIT THIS FIELD IF IT IS PART OF A NATIONAL REGISTRY DEFINITION! 
                                 
                                If the BACKGROUND PROCESSING? field is set to 'YES' then the report will be scheduled to run as a
                                background task.  

              TECHNICAL DESCR:
                                Only background processing is currently implemented.  

              DELETE TEST:      1,0)= I $$VADEL^RORDD(799.34,$G(DA))

              DELETE AUTHORITY: @
              WRITE AUTHORITY:  @
              NOTES:            XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER


799.34,.03    SHARED TEMPLATES       0;3 SET

                                '0' FOR NO; 
                                '1' FOR YES; 
              INPUT TRANSFORM:  Q:$$VAEDT^RORDD(799.34,$G(DA))
              LAST EDITED:      NOV 21, 2005 
              DESCRIPTION:      YOU MUST NOT EDIT THIS FIELD IF IT IS PART OF A NATIONAL REGISTRY DEFINITION! 
                                 
                                If this field is set to 'YES', then report parameter templates are shared between all registries.
                                Otherwise, the templates are registry-specific.  

              DELETE TEST:      1,0)= I $$VADEL^RORDD(799.34,$G(DA))

              DELETE AUTHORITY: @
              WRITE AUTHORITY:  @
              NOTES:            XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER


799.34,.04    CODE                   0;4 NUMBER (Required) (Key field)

              INPUT TRANSFORM:  Q:$$VAEDT^RORDD(799.34,$G(DA))  K:+X'=X!(X>999)!(X<1)!(X?.E1"."1N.N) X
              LAST EDITED:      APR 01, 2003 
              HELP-PROMPT:      Enter the unique report code (between 1 and 999, 0 Decimal Digits). 
              DESCRIPTION:      YOU MUST NOT EDIT THIS FIELD IF IT IS PART OF A NATIONAL REGISTRY DEFINITION! 
                                 
                                The CODE field stores the unique code of the report.  

              TECHNICAL DESCR:  The corresponding XSL templates for the report are stored in the DIALOG file (#.84). The dialog
                                number of the template has the following structure: 
                                 
                                 7981CCC.TTT 
                                 
                                 'CCC' is the code of the report.  
                                 
                                 'TTT' is the type of the template: 
                                        001 - HTML Preview, 
                                        002 - Delimited Format (CSV), 
                                        003 - Printer Output.  
                                 
                                For example, the dialog 7981001.001 contains the HTML preview template for the List of Registry
                                Patients (report code: 1).  
                                 
                                If no template is defined for the report then the default template from dialog 7981000 is used.  

              DELETE AUTHORITY: @
              WRITE AUTHORITY:  @
              NOTES:            XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER

              FIELD INDEX:      KEY (#372)    REGULAR    IR    LOOKUP & SORTING
                   Unique for:  Key A (#41), File #799.34
                  Short Descr:  Uniqueness Index for Key 'A' of File #799.34
                    Set Logic:  S ^ROR(799.34,"KEY",X,DA)=""
                   Kill Logic:  K ^ROR(799.34,"KEY",X,DA)
                   Whole Kill:  K ^ROR(799.34,"KEY")
                         X(1):  CODE  (799.34,.04)  (Subscr 1)


799.34,.05    DATE OF INACTIVATION   0;5 DATE

              INPUT TRANSFORM:  S %DT="ESTX" D ^%DT S X=Y K:Y<1 X
              LAST EDITED:      NOV 26, 2002 
              DESCRIPTION:      If this field has a value, the report will be considered inactive after this date. Use this field
                                to disable unnecessary reports (and hide them from the Report sub-menu of the GUI) instead of
                                deleting them.  

              TECHNICAL DESCR:  The ROR REPORTS AVAILABLE remote procedure analyzes this field when it loads the list of available
                                reports and skips the inactive ones.  


799.34,.09    NATIONAL               0;9 SET

                                '0' FOR NO; 
                                '1' FOR YES; 
              INPUT TRANSFORM:  Q:$$VAEDT^RORDD(799.34,,-1)
              LAST EDITED:      NOV 26, 2002 
              DESCRIPTION:      ONLY AUTHORIZED NATIONAL REGISTRY DEVELOPERS CAN EDIT THIS FIELD! 
                                 
                                Reports distributed with the national registries must have this field set to "YES". This prevents 
                                local editing of other fields of report definitions.  

              DELETE TEST:      1,0)= I $$VADEL^RORDD(799.34,,,-1)

              DELETE AUTHORITY: @
              WRITE AUTHORITY:  @
              NOTES:            XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER


799.34,1      PARAMETER PANELS       1;E1,250 FREE TEXT

              INPUT TRANSFORM:  Q:$$VAEDT^RORDD(799.34,$G(DA))  K:$L(X)>250!($L(X)<1) X
              LAST EDITED:      MAR 04, 2003 
              HELP-PROMPT:      Enter codes of dialog panels separated by commas (1-250 characters). 
              DESCRIPTION:      YOU MUST NOT EDIT THIS FIELD IF IT IS PART OF A NATIONAL REGISTRY DEFINITION! 
                                 
                                The PARAMETER PANELS field stores the list of panel codes separated by commas. The panels are 
                                combined by the GUI into the dialog form that is used to request values of the report parameters.  

              DELETE TEST:      1,0)= I $$VADEL^RORDD(799.34,$G(DA))

              DELETE AUTHORITY: @
              WRITE AUTHORITY:  @
              NOTES:            XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER


799.34,10.01  REPORT BUILDER         10.01;E1,245 FREE TEXT (Required)

              INPUT TRANSFORM:  Q:$$VAEDT^RORDD(799.34,$G(DA))  Q:$$EP^RORDD(1)
              LAST EDITED:      NOV 26, 2002 
              HELP-PROMPT:      Answer must be $$TAG^ROUTINE (5-19 characters in length). 
              DESCRIPTION:      YOU MUST NOT EDIT THIS FIELD IF IT IS PART OF A NATIONAL REGISTRY DEFINITION! 
                                 
                                The REPORT BUILDER field stores a reference to the function that is used to build the report (the 
                                report builder).  

              TECHNICAL DESCR:  The call-back entry point is called with a single parameter. The parameter is a reference to a
                                local variable that contains values of the report parameters.  
                                 
                                 RORTSK(            Task Number 
                                 
                                   "EP")            Entry Point ($$TAG^ROUTINE) 
                                 
                                   "PARAMS",...)    See the CCR Programmer's Reference 
                                                    Manual for details 
                                 
                                   "REGIEN")        Registry IEN 
                                 
                                   "TYPE")          Type of the Task 
                                   "REPORT")        Code of the Report 
                                   "SCHCODE")       Rescheduling Code 
                                 
                                The function must return 0 in the case of successful completion. Otherwise, a negative error code
                                must be returned.  
                                 
                                See description of the ROR REPORT SCHEDULE remote procedure and source code of the RORTSK01 routine
                                for more details.  

              DELETE AUTHORITY: @
              WRITE AUTHORITY:  @
              NOTES:            XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER


799.34,11     DEFAULT PARAMETERS     11;0   WORD-PROCESSING #799.3411   (NOWRAP)

              DESCRIPTION:
                                This field stores the default values for the report parameters (in the NAME=VALUE format).  

              WRITE AUTHORITY:  @

                LAST EDITED:      SEP 18, 2003 
                DELETE AUTHORITY: @
                WRITE AUTHORITY:  @



799.34,12     DEFAULT SORTING        12;0   WORD-PROCESSING #799.3412   (NOWRAP)

              DESCRIPTION:
                                This field stores the default sorting modes for the report (in the TABLE=FIELD format).  

              WRITE AUTHORITY:  @

                LAST EDITED:      NOV 03, 2003 
                DELETE AUTHORITY: @
                WRITE AUTHORITY:  @




INPUT TEMPLATE(S):

PRINT TEMPLATE(S):

SORT TEMPLATE(S):

FORM(S)/BLOCK(S):