ClinicalCaseRegistries::Classes
Class RORReportParameters

The ROR REPORT PARAMETERS file stores the report definitions that are used by the ROR REPORT  SCHEDULE remoteprocedure 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).

Attributes
Integer code code

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.

Date dateOfInactivation dateOfInactivation

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.

«File 799.3411» DefaultParameters defaultParameters defaultParameters
«File 799.3412» DefaultSorting defaultSorting defaultSorting
Boolean isBackgroundProcessing isBackgroundProcessing

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.

Boolean isNational isNational

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.

Boolean isSharedTemplates isSharedTemplates

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.

String name name

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.

String parameterPanels parameterPanels

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.

String reportBuilder reportBuilder

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).


Properties:

Alias
businessRule[]
Classifier Behavior
dateAdded5/24/13
dateModified
fileNameROR REPORT PARAMETERS
fileNumber799.34
highLevelConcept
informationDomain
Is Abstractfalse
Is Activefalse
Is Leaffalse
KeywordsFile 799.34
modReason
NameRORReportParameters
Name Expression
NamespaceClasses
note
originalName
Owned Template Signature
OwnerClasses
Owning Template Parameter
PackageClasses
packageNameCLINICAL CASE REGISTRIES
projectID
Qualified NameHybrid::ClinicalCaseRegistries::Classes::RORReportParameters
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
Representation
requestedBy
rootClass
StereotypeClassDictionary, VistaClassDictionary
synonym
Template Parameter
VisibilityPublic

Attribute Details

 code
Public Integer code

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.

Constraints:
Properties:

absMaxLength3
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 799.34» RORReportParameters
dataTypeNUMERIC
Datatype
dateAdded05/24/13
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameCODE
fieldNumber.04
fileNumber799.34
formatRule
formatString
generalDescriptionYOU MUST NOT EDIT THIS FIELD IF IT IS PART OF A NATIONAL REGISTRY DEFINITION! The CODE field stores the unique code of the report.
helpTextEnter the unique report code (between 1 and 999, 0 Decimal Digits).
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredTrue
Keywords
Lower1
Lower Value(1)
maxLength-
minLength-
modReason
Multiplicity1
Namecode
Name Expression
Namespace«File 799.34» RORReportParameters
note
Opposite
originalClass
originalName
Owner«File 799.34» RORReportParameters
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::ClinicalCaseRegistries::Classes::RORReportParameters::code
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary, VistaAttributeDictionary
subFileNumber-
synonym
technicalDescriptionThe 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.
Template Parameter
TypeInteger
Upper1
Upper Value(1)
VisibilityPublic


 dateOfInactivation
Public Date dateOfInactivation

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.

Constraints:
Properties:

absMaxLength21
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 799.34» RORReportParameters
dataTypeDATE/TIME
Datatype
dateAdded05/24/13
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameDATE OF INACTIVATION
fieldNumber.05
fileNumber799.34
formatRule
formatString
generalDescriptionIf 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.
helpText-
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
Keywords
Lower0
Lower Value(0)
maxLength-
minLength-
modReason
Multiplicity0..1
NamedateOfInactivation
Name Expression
Namespace«File 799.34» RORReportParameters
note
Opposite
originalClass
originalName
Owner«File 799.34» RORReportParameters
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::ClinicalCaseRegistries::Classes::RORReportParameters::dateOfInactivation
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary, VistaAttributeDictionary
subFileNumber-
synonym
technicalDescriptionThe ROR REPORTS AVAILABLE remote procedure analyzes this field when it loads the list of available reports and skips the inactive ones.
Template Parameter
TypeDate
Upper1
Upper Value(1)
VisibilityPublic


 defaultParameters
Public «File 799.3411» DefaultParameters defaultParameters
Constraints:
Properties:

AggregationNone
Alias
Association«VistaAssociationDictionary» (defaultParameters:DefaultParameters)
Association End
businessRule[]
Class«File 799.34» RORReportParameters
Datatype
dateAdded
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
formatRule
formatString
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isNullableFalse
Keywords
Lower0
Lower Value(0)
modReason
Multiplicity0..1
NamedefaultParameters
Name Expression
Namespace«File 799.34» RORReportParameters
note
Opposite
originalClass
originalName
Owner«File 799.34» RORReportParameters
Owning Association
Owning Template Parameter
Qualified NameHybrid::ClinicalCaseRegistries::Classes::RORReportParameters::defaultParameters
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary
synonym
Template Parameter
Type«File 799.3411» DefaultParameters
Upper1
Upper Value(1)
VisibilityPublic


 defaultSorting
Public «File 799.3412» DefaultSorting defaultSorting
Constraints:
Properties:

AggregationNone
Alias
Association«VistaAssociationDictionary» (defaultSorting:DefaultSorting)
Association End
businessRule[]
Class«File 799.34» RORReportParameters
Datatype
dateAdded
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
formatRule
formatString
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isNullableFalse
Keywords
Lower0
Lower Value(0)
modReason
Multiplicity0..1
NamedefaultSorting
Name Expression
Namespace«File 799.34» RORReportParameters
note
Opposite
originalClass
originalName
Owner«File 799.34» RORReportParameters
Owning Association
Owning Template Parameter
Qualified NameHybrid::ClinicalCaseRegistries::Classes::RORReportParameters::defaultSorting
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary
synonym
Template Parameter
Type«File 799.3412» DefaultSorting
Upper1
Upper Value(1)
VisibilityPublic


 isBackgroundProcessing
Public Boolean isBackgroundProcessing

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.

Constraints:
Properties:

absMaxLength3
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 799.34» RORReportParameters
dataTypeSET
Datatype
dateAdded05/24/13
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameBACKGROUND PROCESSING?
fieldNumber.02
fileNumber799.34
formatRule
formatString
generalDescriptionYOU 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.
helpText-
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
Keywords
Lower0
Lower Value(0)
maxLength-
minLength-
modReason
Multiplicity0..1
NameisBackgroundProcessing
Name Expression
Namespace«File 799.34» RORReportParameters
note
Opposite
originalClass
originalName
Owner«File 799.34» RORReportParameters
Owning Association
Owning Template Parameter
permissableValueMeaningsNO;YES
permissableValues0;1
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::ClinicalCaseRegistries::Classes::RORReportParameters::isBackgroundProcessing
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary, VistaAttributeDictionary
subFileNumber-
synonym
technicalDescriptionOnly background processing is currently implemented.
Template Parameter
TypeBoolean
Upper1
Upper Value(1)
VisibilityPublic


 isNational
Public Boolean isNational

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.

Constraints:
Properties:

absMaxLength3
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 799.34» RORReportParameters
dataTypeSET
Datatype
dateAdded05/24/13
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameNATIONAL
fieldNumber.09
fileNumber799.34
formatRule
formatString
generalDescriptionONLY 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.
helpText-
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
Keywords
Lower0
Lower Value(0)
maxLength-
minLength-
modReason
Multiplicity0..1
NameisNational
Name Expression
Namespace«File 799.34» RORReportParameters
note
Opposite
originalClass
originalName
Owner«File 799.34» RORReportParameters
Owning Association
Owning Template Parameter
permissableValueMeaningsNO;YES
permissableValues0;1
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::ClinicalCaseRegistries::Classes::RORReportParameters::isNational
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary, VistaAttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
TypeBoolean
Upper1
Upper Value(1)
VisibilityPublic


 isSharedTemplates
Public Boolean isSharedTemplates

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.

Constraints:
Properties:

absMaxLength3
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 799.34» RORReportParameters
dataTypeSET
Datatype
dateAdded05/24/13
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameSHARED TEMPLATES
fieldNumber.03
fileNumber799.34
formatRule
formatString
generalDescriptionYOU 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.
helpText-
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
Keywords
Lower0
Lower Value(0)
maxLength-
minLength-
modReason
Multiplicity0..1
NameisSharedTemplates
Name Expression
Namespace«File 799.34» RORReportParameters
note
Opposite
originalClass
originalName
Owner«File 799.34» RORReportParameters
Owning Association
Owning Template Parameter
permissableValueMeaningsNO;YES
permissableValues0;1
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::ClinicalCaseRegistries::Classes::RORReportParameters::isSharedTemplates
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary, VistaAttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
TypeBoolean
Upper1
Upper Value(1)
VisibilityPublic


 name
Public String name

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.

Constraints:
Properties:

absMaxLength60
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 799.34» RORReportParameters
dataTypeFREE TEXT
Datatype
dateAdded05/24/13
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameNAME
fieldNumber.01
fileNumber799.34
formatRule
formatString
generalDescriptionYOU 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.
helpTextEnter the report name (3-60 characters).
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredTrue
Keywords
Lower1
Lower Value(1)
maxLength-
minLength-
modReason
Multiplicity1
Namename
Name Expression
Namespace«File 799.34» RORReportParameters
note
Opposite
originalClass
originalName
Owner«File 799.34» RORReportParameters
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::ClinicalCaseRegistries::Classes::RORReportParameters::name
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary, VistaAttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 parameterPanels
Public String parameterPanels

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.

Constraints:
Properties:

absMaxLength250
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 799.34» RORReportParameters
dataTypeFREE TEXT
Datatype
dateAdded05/24/13
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNamePARAMETER PANELS
fieldNumber1
fileNumber799.34
formatRule
formatString
generalDescriptionYOU 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.
helpTextEnter codes of dialog panels separated by commas (1-250 characters).
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
Keywords
Lower0
Lower Value(0)
maxLength-
minLength-
modReason
Multiplicity0..1
NameparameterPanels
Name Expression
Namespace«File 799.34» RORReportParameters
note
Opposite
originalClass
originalName
Owner«File 799.34» RORReportParameters
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::ClinicalCaseRegistries::Classes::RORReportParameters::parameterPanels
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary, VistaAttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 reportBuilder
Public String reportBuilder

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).

Constraints:
Properties:

absMaxLength1
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 799.34» RORReportParameters
dataTypeFREE TEXT
Datatype
dateAdded05/24/13
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameREPORT BUILDER
fieldNumber10.01
fileNumber799.34
formatRule
formatString
generalDescriptionYOU 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).
helpTextAnswer must be $$TAG^ROUTINE (5-19 characters in length).
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredTrue
Keywords
Lower1
Lower Value(1)
maxLength-
minLength-
modReason
Multiplicity1
NamereportBuilder
Name Expression
Namespace«File 799.34» RORReportParameters
note
Opposite
originalClass
originalName
Owner«File 799.34» RORReportParameters
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::ClinicalCaseRegistries::Classes::RORReportParameters::reportBuilder
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary, VistaAttributeDictionary
subFileNumber-
synonym
technicalDescriptionThe 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.
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic