ClinicalCaseRegistries::Classes
Class Task

Sub-File of file 799.6 ROR HISTORICAL DATA EXTRACTION.

Attributes
«File 799.641» Error error error
String fileName fileName

The output file name is stored in this field. This name is generated automatically when the task is created. The name has the following structure: BASE-SSS-TT.HDT where 'BASE' is the base part of the file name provided by the user during creation of the task table 'SSS' is the site number (3 digits), and 'TT' is the sequential number of the task (2 digits). If the task is restarted, the optional numeric modifier '##' (2 digits) can be added to the name so that the already extracted data will not be overwritten: BASE-SSS-TT-##.HDT Usually, this field should not be edited. It is populated automatically when the task is created or restarted.

Integer nextPatientIen nextPatientIen

If the data extraction task is stopped, it finishes processing the current patient and stores the IEN of the patient that should be processed next as the value of this field. When the task is restarted, it starts from the patient IEN stored in this field. Usually, this field should not be edited. It is updated automatically by the data extraction task.

Integer startRecordIen startRecordIen

All patients of the registries are distributed between the data extraction tasks. Each task extracts the data of the patients whose DFNs are not less than the value of this field in the task record and are less than the value of the field in the next task record. The first task always has 1 as a value in this field (just in case). The last task extracts the data of all patients whose registry records have IENs not less than the value of this field. Usually, this field should not be edited. It is populated automatically when the task is created.

TaskStatusList status status

The STATUS field stores the last known task status.

Integer taskNumber taskNumber

This field contains the number of the Taskman task (scheduled or running) that does the data extraction. This field cannot be edited. It is updated automatically by the data extraction task.


Properties:

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

Attribute Details

 error
Public «File 799.641» Error error
Constraints:
Properties:

absMaxLength
AggregationNone
Alias
Association«VistaAssociationDictionary» (error:Error)
Association End
businessRule[]
Class«File 799.64» Task
dataType
Datatype
dateAdded
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldName
fieldNumber
fileNumber
formatRule
formatString
generalDescription
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
Multiplicity*
Nameerror
Name Expression
Namespace«File 799.64» Task
note
Opposite
originalClass
originalName
Owner«File 799.64» Task
Owning Association
Owning Template Parameter
permissableValueMeanings
permissableValues
pointerFileName
pointerFileNumber
Qualified NameHybrid::ClinicalCaseRegistries::Classes::Task::error
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary, VistaAttributeDictionary
subFileNumber
synonym
technicalDescription
Template Parameter
Type«File 799.641» Error
Upper*
Upper Value(*)
VisibilityPublic


 fileName
Public String fileName

The output file name is stored in this field. This name is generated automatically when the task is created. The name has the following structure: BASE-SSS-TT.HDT where 'BASE' is the base part of the file name provided by the user during creation of the task table 'SSS' is the site number (3 digits), and 'TT' is the sequential number of the task (2 digits). If the task is restarted, the optional numeric modifier '##' (2 digits) can be added to the name so that the already extracted data will not be overwritten: BASE-SSS-TT-##.HDT Usually, this field should not be edited. It is populated automatically when the task is created or restarted.

Constraints:
Properties:

absMaxLength50
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 799.64» Task
dataTypeFREE TEXT
Datatype
dateAdded05/24/13
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameFILE NAME
fieldNumber.05
fileNumber799.64
formatRule
formatString
generalDescriptionThe output file name is stored in this field. This name is generated automatically when the task is created. The name has the following structure: BASE-SSS-TT.HDT where 'BASE' is the base part of the file name provided by the user during creation of the task table 'SSS' is the site number (3 digits), and 'TT' is the sequential number of the task (2 digits). If the task is restarted, the optional numeric modifier '##' (2 digits) can be added to the name so that the already extracted data will not be overwritten: BASE-SSS-TT-##.HDT Usually, this field should not be edited. It is populated automatically when the task is created or restarted.
helpTextAnswer must be 1-50 characters in length.
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)
maxLength50
minLength1
modReason
Multiplicity0..1
NamefileName
Name Expression
Namespace«File 799.64» Task
note
Opposite
originalClass
originalName
Owner«File 799.64» Task
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::ClinicalCaseRegistries::Classes::Task::fileName
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary, VistaAttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 nextPatientIen
Public Integer nextPatientIen

If the data extraction task is stopped, it finishes processing the current patient and stores the IEN of the patient that should be processed next as the value of this field. When the task is restarted, it starts from the patient IEN stored in this field. Usually, this field should not be edited. It is updated automatically by the data extraction task.

Constraints:
Properties:

absMaxLength22
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 799.64» Task
dataTypeNUMERIC
Datatype
dateAdded05/24/13
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameNEXT PATIENT IEN
fieldNumber.04
fileNumber799.64
formatRule
formatString
generalDescriptionIf the data extraction task is stopped, it finishes processing the current patient and stores the IEN of the patient that should be processed next as the value of this field. When the task is restarted, it starts from the patient IEN stored in this field. Usually, this field should not be edited. It is updated automatically by the data extraction task.
helpTextEnter the next patient IEN (1-999999999999, 9 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
NamenextPatientIen
Name Expression
Namespace«File 799.64» Task
note
Opposite
originalClass
originalName
Owner«File 799.64» Task
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::ClinicalCaseRegistries::Classes::Task::nextPatientIen
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary, VistaAttributeDictionary
subFileNumber-
synonym
technicalDescriptionThe value of this field is not a real pointer to the ROR PATIENT file. There can be no record in the file with IEN stored in this field. The restarted historical data extraction task will continue processing from the patient with an IEN that is not less than the value of this field.
Template Parameter
TypeInteger
Upper1
Upper Value(1)
VisibilityPublic


 startRecordIen
Public Integer startRecordIen

All patients of the registries are distributed between the data extraction tasks. Each task extracts the data of the patients whose DFNs are not less than the value of this field in the task record and are less than the value of the field in the next task record. The first task always has 1 as a value in this field (just in case). The last task extracts the data of all patients whose registry records have IENs not less than the value of this field. Usually, this field should not be edited. It is populated automatically when the task is created.

Constraints:
Properties:

absMaxLength22
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 799.64» Task
dataTypeNUMERIC
Datatype
dateAdded05/24/13
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameSTART RECORD IEN
fieldNumber.01
fileNumber799.64
formatRule
formatString
generalDescriptionAll patients of the registries are distributed between the data extraction tasks. Each task extracts the data of the patients whose DFNs are not less than the value of this field in the task record and are less than the value of the field in the next task record. The first task always has 1 as a value in this field (just in case). The last task extracts the data of all patients whose registry records have IENs not less than the value of this field. Usually, this field should not be edited. It is populated automatically when the task is created.
helpTextEnter a patient's IEN (DFN).
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
NamestartRecordIen
Name Expression
Namespace«File 799.64» Task
note
Opposite
originalClass
originalName
Owner«File 799.64» Task
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::ClinicalCaseRegistries::Classes::Task::startRecordIen
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary, VistaAttributeDictionary
subFileNumber-
synonym
technicalDescriptionThe value of this field is not a real pointer to the ROR REGISTRY RECORD file. There can be no record in the local registry with an IEN stored in this field. The historical data extraction task will start processing from the registry record with an IEN that is not less than the value of this field.
Template Parameter
TypeInteger
Upper1
Upper Value(1)
VisibilityPublic


 status
Public TaskStatusList status

The STATUS field stores the last known task status.

Constraints:
Properties:

absMaxLength21
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 799.64» Task
dataTypeSET
Datatype
dateAdded05/24/13
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameSTATUS
fieldNumber.03
fileNumber799.64
formatRule
formatString
generalDescriptionThe STATUS field stores the last known task status.
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
Namestatus
Name Expression
Namespace«File 799.64» Task
note
Opposite
originalClass
originalName
Owner«File 799.64» Task
Owning Association
Owning Template Parameter
permissableValueMeaningsUnknown;Active> Pending;Active> Running;Inactive> Finished;Inactive> Available;Inactive> Interrupted;Inactive> Crashed;Inactive> Errors;Active> Suspended;Active> Stopping
permissableValues0;1;2;3;4;5;100;101;102;103
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::ClinicalCaseRegistries::Classes::Task::status
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary, VistaAttributeDictionary
subFileNumber-
synonym
technicalDescriptionThis field is populated with the value returned by the $$STATUS^RORTSK02 function. It will reflect the last known status of the task even after the task is deleted by the Taskman and its record is deleted from the ROR TASK file (#798.8). Please do not get value of this field directly; use the $$STATUS^RORHDTUT function instead.
Template Parameter
TypeTaskStatusList
Upper1
Upper Value(1)
VisibilityPublic


 taskNumber
Public Integer taskNumber

This field contains the number of the Taskman task (scheduled or running) that does the data extraction. This field cannot be edited. It is updated automatically by the data extraction task.

Constraints:
Properties:

absMaxLength10
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 799.64» Task
dataTypeNUMERIC
Datatype
dateAdded05/24/13
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameTASK NUMBER
fieldNumber.02
fileNumber799.64
formatRule
formatString
generalDescriptionThis field contains the number of the Taskman task (scheduled or running) that does the data extraction. This field cannot be edited. It is updated automatically by the data extraction task.
helpTextType a 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 799.64» Task
note
Opposite
originalClass
originalName
Owner«File 799.64» Task
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::ClinicalCaseRegistries::Classes::Task::taskNumber
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary, VistaAttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
TypeInteger
Upper1
Upper Value(1)
VisibilityPublic