ClinicalCaseRegistries::Classes
Class RORLog

The ROR LOG file is used for recording different kinds of events (errors, debug messages, etc.) that are generated byregistry processes.   You may control event recording via parameters in the ROR REGISTRY PARAMETERS file. Lookfor additional information in the RORLOG and RORERR routines.   A permanent screen (the ^DD(798.7,0,"SCR")node)  restricts access to records of this file. Only users with the security key(s) for any defined  registry(or those with the ROR VA IRM security key) can access records of the file.   If you want the changes in thesecurity keys  allocation to have an effect immediately, you should rebuild the "ACL" cross-reference of the .01 fieldof the SECURITY KEY multiple of the ROR REGISTRY PARAMETERS file (#798.1). See the  description of the cross-referencefor more details.

Attributes
RORLogActivityList activity activity

The value of this field indicates the activity performed by the process that created the log.

Datetime endDateTime endDateTime

This field contains the date/time when the log was closed.

Integer jobNumber jobNumber

Value of the JOB NUMBER field is the job number ($JOB) of the process that has created this log.

Datetime message message

This multiple contains all messages recorded in the log.

Integer patientsWithErrors patientsWithErrors

The value of this field indicates the number of patients processed with errors.

Integer processedPatients processedPatients

The value of this field indicates the number of processed patients.

Integer rate rate

The value of this field indicates the rate of patient processing (patients per second).

«File 798.73» Registry registry registry
Datetime startDateTime startDateTime

This field contains the date/time when this log was created. You can access records of this file only if you have appropriate security key(s) for any registry.

Integer taskNumber taskNumber

This field stores the number of the task that created the log. If the log is created from a foreground job, this field will be empty.

«File 200» NewPerson user user

The USER field points to the VistA user associated with the log (its internal value is the DUZ at the moment when the log was created).


Properties:

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

Attribute Details

 activity
Public RORLogActivityList activity

The value of this field indicates the activity performed by the process that created the log.

Constraints:
Properties:

absMaxLength16
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 798.7» RORLog
dataTypeSET
Datatype
dateAdded05/24/13
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameACTIVITY
fieldNumber1
fileNumber798.7
formatRule
formatString
generalDescriptionThe value of this field indicates the activity performed by the process that created the log.
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
Nameactivity
Name Expression
Namespace«File 798.7» RORLog
note
Opposite
originalClass
originalName
Owner«File 798.7» RORLog
Owning Association
Owning Template Parameter
permissableValueMeaningsOther;Registry Update;Data Extraction;Acknowledgement;Hist. Extraction;Report;Access Violation;ROR TASK;Registry Setup
permissableValues0;1;2;3;4;5;6;7;8
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::ClinicalCaseRegistries::Classes::RORLog::activity
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary, VistaAttributeDictionary
subFileNumber-
synonym
technicalDescriptionThis field is populated by the $$OPEN^RORLOG function with the value passed as one of the parameters.
Template Parameter
TypeRORLogActivityList
Upper1
Upper Value(1)
VisibilityPublic


 endDateTime
Public Datetime endDateTime

This field contains the date/time when the log was closed.

Constraints:
Properties:

absMaxLength21
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 798.7» RORLog
dataTypeDATE/TIME
Datatype
dateAdded05/24/13
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameEND DATE/TIME
fieldNumber5
fileNumber798.7
formatRule
formatString
generalDescriptionThis field contains the date/time when the log was closed.
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
NameendDateTime
Name Expression
Namespace«File 798.7» RORLog
note
Opposite
originalClass
originalName
Owner«File 798.7» RORLog
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::ClinicalCaseRegistries::Classes::RORLog::endDateTime
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary, VistaAttributeDictionary
subFileNumber-
synonym
technicalDescriptionThe CLOSE^RORLOG procedure populates this field automatically when the log is closed.
Template Parameter
TypeDatetime
Upper1
Upper Value(1)
VisibilityPublic


 jobNumber
Public Integer jobNumber

Value of the JOB NUMBER field is the job number ($JOB) of the process that has created this log.

Constraints:
Properties:

absMaxLength12
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 798.7» RORLog
dataTypeNUMERIC
Datatype
dateAdded05/24/13
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameJOB NUMBER
fieldNumber2
fileNumber798.7
formatRule
formatString
generalDescriptionValue of the JOB NUMBER field is the job number ($JOB) of the process that has created this log.
helpTextEnter a job number between 1 and 999999999999, 0 Decimal Digits.
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
NamejobNumber
Name Expression
Namespace«File 798.7» RORLog
note
Opposite
originalClass
originalName
Owner«File 798.7» RORLog
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::ClinicalCaseRegistries::Classes::RORLog::jobNumber
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary, VistaAttributeDictionary
subFileNumber-
synonym
technicalDescriptionThis field is populated automatically by the $$OPEN^RORLOG function.
Template Parameter
TypeInteger
Upper1
Upper Value(1)
VisibilityPublic


 message
Public Datetime message

This multiple contains all messages recorded in the log.

Constraints:
Properties:

absMaxLength21
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 798.7» RORLog
dataTypeDATE/TIME
Datatype
dateAdded05/24/13
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameMESSAGE
fieldNumber4
fileNumber798.7
formatRule
formatString
generalDescriptionThis multiple contains all messages recorded in the log.
helpText-
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleTrue
isNullableFalse
isRequiredFalse
Keywords
Lower0
Lower Value(0)
maxLength-
minLength-
modReason
Multiplicity0..1
Namemessage
Name Expression
Namespace«File 798.7» RORLog
note
Opposite
originalClass
originalName
Owner«File 798.7» RORLog
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::ClinicalCaseRegistries::Classes::RORLog::message
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary, VistaAttributeDictionary
subFileNumber798.74
synonym
technicalDescriptionEvery call of the LOG^RORLOG procedure adds a new record to this multiple. The $$OPEN^RORLOG and CLOSE^RORLOG entry points can also call the LOG^RORLOG automatically to add a header and footer to the log.
Template Parameter
TypeDatetime
Upper1
Upper Value(1)
VisibilityPublic


 patientsWithErrors
Public Integer patientsWithErrors

The value of this field indicates the number of patients processed with errors.

Constraints:
Properties:

absMaxLength12
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 798.7» RORLog
dataTypeNUMERIC
Datatype
dateAdded05/24/13
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNamePATIENTS WITH ERRORS
fieldNumber6.02
fileNumber798.7
formatRule
formatString
generalDescriptionThe value of this field indicates the number of patients processed with errors.
helpTextType a Number between 0 and 999999999999, 0 Decimal Digits.
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
NamepatientsWithErrors
Name Expression
Namespace«File 798.7» RORLog
note
Opposite
originalClass
originalName
Owner«File 798.7» RORLog
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::ClinicalCaseRegistries::Classes::RORLog::patientsWithErrors
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary, VistaAttributeDictionary
subFileNumber-
synonym
technicalDescriptionThe value of this field is also duplicated in the last message of the log (footer).
Template Parameter
TypeInteger
Upper1
Upper Value(1)
VisibilityPublic


 processedPatients
Public Integer processedPatients

The value of this field indicates the number of processed patients.

Constraints:
Properties:

absMaxLength12
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 798.7» RORLog
dataTypeNUMERIC
Datatype
dateAdded05/24/13
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNamePROCESSED PATIENTS
fieldNumber6.01
fileNumber798.7
formatRule
formatString
generalDescriptionThe value of this field indicates the number of processed patients.
helpTextType a Number between 0 and 999999999999, 0 Decimal Digits.
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
NameprocessedPatients
Name Expression
Namespace«File 798.7» RORLog
note
Opposite
originalClass
originalName
Owner«File 798.7» RORLog
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::ClinicalCaseRegistries::Classes::RORLog::processedPatients
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary, VistaAttributeDictionary
subFileNumber-
synonym
technicalDescriptionThe value of this field is also duplicated in the last message of the log (footer).
Template Parameter
TypeInteger
Upper1
Upper Value(1)
VisibilityPublic


 rate
Public Integer rate

The value of this field indicates the rate of patient processing (patients per second).

Constraints:
Properties:

absMaxLength16
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 798.7» RORLog
dataTypeNUMERIC
Datatype
dateAdded05/24/13
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameRATE
fieldNumber6.03
fileNumber798.7
formatRule
formatString
generalDescriptionThe value of this field indicates the rate of patient processing (patients per second).
helpTextType a Number between 0 and 999999999999, 3 Decimal Digits.
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
Namerate
Name Expression
Namespace«File 798.7» RORLog
note
Opposite
originalClass
originalName
Owner«File 798.7» RORLog
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::ClinicalCaseRegistries::Classes::RORLog::rate
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary, VistaAttributeDictionary
subFileNumber-
synonym
technicalDescriptionThe value of this field is also duplicated in the last message of the log (footer).
Template Parameter
TypeInteger
Upper1
Upper Value(1)
VisibilityPublic


 registry
Public «File 798.73» Registry registry
Constraints:
Properties:

AggregationNone
Alias
Association«VistaAssociationDictionary» (registry:Registry)
Association End
businessRule[]
Class«File 798.7» RORLog
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
Multiplicity*
Nameregistry
Name Expression
Namespace«File 798.7» RORLog
note
Opposite
originalClass
originalName
Owner«File 798.7» RORLog
Owning Association
Owning Template Parameter
Qualified NameHybrid::ClinicalCaseRegistries::Classes::RORLog::registry
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary
synonym
Template Parameter
Type«File 798.73» Registry
Upper*
Upper Value(*)
VisibilityPublic


 startDateTime
Public Datetime startDateTime

This field contains the date/time when this log was created. You can access records of this file only if you have appropriate security key(s) for any registry.

Constraints:
Properties:

absMaxLength21
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 798.7» RORLog
dataTypeDATE/TIME
Datatype
dateAdded05/24/13
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameSTART DATE/TIME
fieldNumber.01
fileNumber798.7
formatRule
formatString
generalDescriptionThis field contains the date/time when this log was created. You can access records of this file only if you have appropriate security key(s) for any registry.
helpText-
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
NamestartDateTime
Name Expression
Namespace«File 798.7» RORLog
note
Opposite
originalClass
originalName
Owner«File 798.7» RORLog
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::ClinicalCaseRegistries::Classes::RORLog::startDateTime
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary, VistaAttributeDictionary
subFileNumber-
synonym
technicalDescriptionThe $$OPEN^RORLOG function populates this field automatically when a new log is created.
Template Parameter
TypeDatetime
Upper1
Upper Value(1)
VisibilityPublic


 taskNumber
Public Integer taskNumber

This field stores the number of the task that created the log. If the log is created from a foreground job, this field will be empty.

Constraints:
Properties:

absMaxLength10
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 798.7» RORLog
dataTypeNUMERIC
Datatype
dateAdded05/24/13
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameTASK NUMBER
fieldNumber8
fileNumber798.7
formatRule
formatString
generalDescriptionThis field stores the number of the task that created the log. If the log is created from a foreground job, this field will be empty.
helpTextEnter a task number between 1 and 9899999999, 0 Decimal Digits.
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
NametaskNumber
Name Expression
Namespace«File 798.7» RORLog
note
Opposite
originalClass
originalName
Owner«File 798.7» RORLog
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::ClinicalCaseRegistries::Classes::RORLog::taskNumber
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary, VistaAttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
TypeInteger
Upper1
Upper Value(1)
VisibilityPublic


 user
Public «File 200» NewPerson user

The USER field points to the VistA user associated with the log (its internal value is the DUZ at the moment when the log was created).

Constraints:
Properties:

absMaxLength35
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 798.7» RORLog
dataTypePOINTER
Datatype
dateAdded05/24/13
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameUSER
fieldNumber7
fileNumber798.7
formatRule
formatString
generalDescriptionThe USER field points to the VistA user associated with the log (its internal value is the DUZ at the moment when the log was created).
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
Nameuser
Name Expression
Namespace«File 798.7» RORLog
note
Opposite
originalClass
originalName
Owner«File 798.7» RORLog
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileNameNEW PERSON
pointerFileNumber200
Qualified NameHybrid::ClinicalCaseRegistries::Classes::RORLog::user
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary, VistaAttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
Type«File 200» NewPerson
Upper1
Upper Value(1)
VisibilityPublic