Home Package List Routine Alphabetical List Global Alphabetical List FileMan Files List FileMan Sub-Files List Package Component Lists Package-Namespace Mapping

Info | Desc | Directly Accessed By Routines | Accessed By FileMan Db Calls | Pointer To FileMan Files | Fields | External References | Global Variables Directly Accessed | Naked Globals | Local Variables | All

Print Page as PDF

Global: ^RORDATA(798.8

Package: Clinical Case Registries

Global: ^RORDATA(798.8

Information

FileMan FileNo	FileMan Filename	Package
798.8	ROR TASK	Clinical Case Registries

Description

The ROR TASK file enhances the functionality of Taskman and supports the package APIs used by the GUI to schedule and control tasks, and view and print reports. Records in the file have the same internal entry numbers as the corresponding tasks in Taskman. The records are uniquely identified by the internal value of the TASK NUMBER field. Usually, you should not edit records of this file directly. The file is maintained by the APIs located in the RORTSK* routines. A permanent screen (the ^DD(798.8,0,"SCR") node) restricts access to the 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 the security keys allocation to have an effect immediately, you should rebuild the "ACL" cross-reference of the .01 field of the SECURITY KEY multiple of the ROR REGISTRY PARAMETERS file (#798.1). See the description of the cross-reference for more details.

Directly Accessed By Routines, Total: 9

Package	Total	Routines
Clinical Case Registries	9	ATTRIBUTE ERROR REPORT ELEMENT RORTSK RORTSK01 RORTSK02 RORTSK11 RORXU009 ^RORDATA(798.8

Accessed By FileMan Db Calls, Total: 2

Package	Total	Routines
Clinical Case Registries	2	RORTSK RORTSK02

Pointer To FileMan Files, Total: 5

Package	Total	FileMan Files
Clinical Case Registries	4	ROR REGISTRY PARAMETERS(#798.1)[.03] ROR XML ITEM(#799.31)[#798.87(.01), #798.872(.01)] ROR REPORT PARAMETERS(#799.34)[.04] ROR LOG(#798.7)[2.03]
Kernel	1	NEW PERSON(#200)[.08]

Fields, Total: 16

Field #	Name	Loc	Type	Details
.01	TASK NUMBER	0;1	NUMBER	**********************REQUIRED FIELD********************** INPUT TRANSFORM: `K:+X'=X!(X>9899999999)!(X<1)!(X?.E1"."1N.N) X S:$D(X) DINUM=X` LAST EDITED: `OCT 27, 2003` HELP-PROMPT: `Type a Number between 1 and 9899999999, 0 Decimal Digits` DESCRIPTION: `The TASK NUMBER field references the task created by Taskman.` TECHNICAL DESCR: `Internal value of this field is used as the internal entry number of record ("DINUM" feature).` `DELETE AUTHORITY: @` `WRITE AUTHORITY: @` `UNEDITABLE` NOTES: `XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER` CROSS-REFERENCE: `798.8^B` `1)= S ^RORDATA(798.8,"B",$E(X,1,30),DA)=""` `2)= K ^RORDATA(798.8,"B",$E(X,1,30),DA)` `3)= Do not delete!` CROSS-REFERENCE: `^^TRIGGER^798.8^.07` `1)= X ^DD(798.8,.01,1,2,1.3) I X S X=DIV S Y(1)=$S($D(^RORDATA(798.8,D0,0)):^(0),1:"") S X=$P(Y(1),U,7),X=X S DIU=X K Y S X=DIV N %I,%H,% D NOW^%DTC S X=% X ^DD(798.8,.01,1,2,1.4)` `1.3)= K DIV S DIV=X,D0=DA,DIV(0)=D0 S Y(0)=X S Y(1)=$S($D(^RORDATA(798.8,D0,0)):^(0),1:"") S X=$P(Y(1),U,7)=""` `1.4)= S DIH=$G(^RORDATA(798.8,DIV(0),0)),DIV=X S $P(^(0),U,7)=DIV,DIH=798.8,DIG=.07 D ^DICR` `2)= Q` `3)= Do not delete!` `CREATE CONDITION)= CREATION TIME=""` `CREATE VALUE)= NOW` `DELETE VALUE)= NO EFFECT` `FIELD)= CREATION TIME` `This trigger populates the CREATION TIME field with the current date and time when the task is created.` CROSS-REFERENCE: `^^TRIGGER^798.8^.08` `1)= X ^DD(798.8,.01,1,3,1.3) I X S X=DIV S Y(1)=$S($D(^RORDATA(798.8,D0,0)):^(0),1:"") S X=$P(Y(1),U,8),X=X S DIU=X K Y X ^DD(798.8,.01,1,3,1.1) S DIH=$G(^RORDATA(798.8,DIV(0),0)),DIV=X S $P(^(0),U,8)=DIV,DIH=798.8,DIG=.08` `D ^DICR` `1.1)= S X=DIV X ^DD(798.8,.01,1,3,49.2) S %=$S($D(^VA(200,+DUZ,0)):^(0),1:""),X=$S('DUZ:"??",X="#":DUZ,X="N":$P(%,U,1),X="I":$P(%,U,2),X="T":$S($D(^DIC(3.1,+$P(%,U,9),0)):$P(^(0),U,1),1:""),X="NN":$S($D(^VA(200,+DUZ,.1)):$` `P(^(.1),U,4),1:""),1:"??") K %` `1.3)= K DIV S DIV=X,D0=DA,DIV(0)=D0 S Y(0)=X S Y(1)=$S($D(^RORDATA(798.8,D0,0)):^(0),1:"") S X=$S('$D(^VA(200,+$P(Y(1),U,8),0)):"",1:$P(^(0),U,1))=""` `2)= Q` `3)= Do not delete!` `49.2)= S X="#"` `CREATE CONDITION)= USER=""` `CREATE VALUE)= USER("#")` `DELETE VALUE)= NO EFFECT` `FIELD)= USER` `This trigger populates the USER field with the DUZ of the user who created the task.`
.02	TYPE	0;2	SET	**********************REQUIRED FIELD********************** '1' FOR Generic; '2' FOR Report; LAST EDITED: `OCT 28, 2003` DESCRIPTION: `The TYPE field indicates the type of task.` TECHNICAL DESCR: `Currently only 'Report' tasks are used.` `DELETE AUTHORITY: @` `WRITE AUTHORITY: @` `UNEDITABLE`
.03	REGISTRY	0;3	POINTER TO ROR REGISTRY PARAMETERS FILE (#798.1)	ROR REGISTRY PARAMETERS(#798.1) LAST EDITED: `OCT 28, 2003` DESCRIPTION: `The REGISTRY field references the registry that the task is associated with.` `If this field has no value then the task either works on several registries or does not affect any of them directly.` `DELETE AUTHORITY: @` `WRITE AUTHORITY: @` `UNEDITABLE` CROSS-REFERENCE: `798.8^ADUMMY^MUMPS` `1)= Q` `2)= Q` `3)= Do not delete!` `This dummy cross-reference forces FileMan to flush data during editing a record. This is required for the proper functioning of the REPORT field's screening logic.`
.04	REPORT	0;4	POINTER TO ROR REPORT PARAMETERS FILE (#799.34)	ROR REPORT PARAMETERS(#799.34) LAST EDITED: `JAN 21, 2004` DESCRIPTION: `The REPORT field indicates the report generated by the task. This field has a value only if the type of task is 'Report' (see the TYPE field).` `DELETE AUTHORITY: @` `WRITE AUTHORITY: @` `UNEDITABLE`
.05	DESCRIPTION	0;5	FREE TEXT	INPUT TRANSFORM: `K:$L(X)>60!($L(X)<1) X` LAST EDITED: `NOV 07, 2002` HELP-PROMPT: `Answer must be 1-60 characters in length.` DESCRIPTION: `This field stores the description of task. For reports, it holds the report name.` `DELETE AUTHORITY: @` `WRITE AUTHORITY: @`
.07	CREATION TIME	0;7	DATE	**********************REQUIRED FIELD********************** INPUT TRANSFORM: `S %DT="ESTXR" D ^%DT S X=Y K:Y<1 X` LAST EDITED: `MAR 17, 2003` DESCRIPTION: `The CREATION TIME field stores the date and time when the task was created. This field is populated by the trigger associated with the TASK NUMBER field.` `DELETE AUTHORITY: @` `WRITE AUTHORITY: @` `UNEDITABLE` NOTES: `TRIGGERED by the TASK NUMBER field of the ROR TASK File` CROSS-REFERENCE: `798.8^ACDT` `1)= S ^RORDATA(798.8,"ACDT",$E(X,1,30),DA)=""` `2)= K ^RORDATA(798.8,"ACDT",$E(X,1,30),DA)` `3)= Do not delete!` `The $$PURGE^RORTSK02 function uses the ACDT cross-reference to find and purge old tasks.`
.08	USER	0;8	POINTER TO NEW PERSON FILE (#200)	**********************REQUIRED FIELD********************** NEW PERSON(#200) LAST EDITED: `NOV 09, 2002` DESCRIPTION: `The USER field references the VistA user who created the task. This field is populated by the trigger associated with the TASK NUMBER field.` `DELETE AUTHORITY: @` `WRITE AUTHORITY: @` `UNEDITABLE` NOTES: `TRIGGERED by the TASK NUMBER field of the ROR TASK File` CROSS-REFERENCE: `798.8^U` `1)= S ^RORDATA(798.8,"U",$E(X,1,30),DA)=""` `2)= K ^RORDATA(798.8,"U",$E(X,1,30),DA)` `3)= Do not delete!` `This cross-reference is used to select only the tasks created by a particular user.`
1.01	USER COMMENT	1;1	FREE TEXT	INPUT TRANSFORM: `K:$L(X)>60!($L(X)<1) X` LAST EDITED: `FEB 17, 2005` HELP-PROMPT: `Answer must be 1-60 characters in length.` DESCRIPTION: `This field stores the user comment entered while scheduling the task.` `DELETE AUTHORITY: @` `WRITE AUTHORITY: @`
2.01	STATUS	2;1	SET	'3' FOR Inactive> Finished; '5' FOR Inactive> Interrupted; '100' FOR Inactive> Crashed; '101' FOR Inactive> Errors; '102' FOR Active> Suspended; '103' FOR Active> Stopping; LAST EDITED: `DEC 01, 2003` DESCRIPTION: `The STATUS field stores the current status of the task. The values of this field are used along with those returned by the STAT^%ZTLOAD procedure.` TECHNICAL DESCR: `Codes 3 and 5 are duplicated here so that the most recent status of task will be known even if the task is deleted by Taskman.` `Please do not try to analyze this field yourself; use the $$STATUS^RORTSK02 function instead.` `DELETE AUTHORITY: @` `WRITE AUTHORITY: @`
2.02	COMPLETION TIME	2;2	DATE	INPUT TRANSFORM: `S %DT="ESTXR" D ^%DT S X=Y K:Y<1 X` LAST EDITED: `MAR 17, 2003` DESCRIPTION: `The task populates the COMPLETION TIME field with the current date and time right before the task is completed.` TECHNICAL DESCR: `This field has no value in the following cases:` `* the task has not started yet;` `* the task is still running;` `* the task has crashed;` `* the task has not populated the field` `due to poor design.` `DELETE AUTHORITY: @` `WRITE AUTHORITY: @`
2.03	LOG	2;3	POINTER TO ROR LOG FILE (#798.7)	ROR LOG(#798.7) LAST EDITED: `MAR 18, 2003` DESCRIPTION: `The LOG field references the log created by the task.` TECHNICAL DESCR: `The proxy task used by the reports (TASK^RORTSK01) always creates a log and populates this field.` `DELETE AUTHORITY: @` `WRITE AUTHORITY: @` CROSS-REFERENCE: `798.8^ALOG^MUMPS` `1)= S ^RORDATA(798.7,"AREF",X,798.8,DA_",",2.03)=""` `2)= K ^RORDATA(798.7,"AREF",X,798.8,DA_",",2.03)` `3)= Do not delete!` `The logic of the ALOG cross-reference maintains a list of references from the ROR TASK file to the ROR LOG file. This list allows the function that purges the old logs ($$PURGE^RORLOG01) either to keep those logs that are` `referenced from other files or to remove the references.` `The list is stored under the "AREF" subscript in the ROR LOG file (#798.7) and has the following structure:` `^RORDATA(798.7,"AREF",,798.8,,2.03)` `The is the IEN of the log that is associated with the task (internal value of the LOG field).` `The 798.8 is the number of the file from where the log is referenced (ROR TASK).` `The is the IENS of the record that references the log.` `The 2.03 is the number of the field that points to the log (the LOG field).`
2.04	JOB NUMBER	2;4	NUMBER	INPUT TRANSFORM: `K:+X'=X!(X>999999999999)!(X<1)!(X?.E1"."1N.N) X` LAST EDITED: `NOV 09, 2002` HELP-PROMPT: `Type a Number between 1 and 999999999999, 0 Decimal Digits.` DESCRIPTION: `When the task is running, the JOB NUMBER field holds the job number that is assigned to the task by the M system.` TECHNICAL DESCR: `If the task crashes, this field retains its value. Otherwise, it is cleared right before the task finishes (see the $$EXIT^RORTSK01 function).` `DELETE AUTHORITY: @` `WRITE AUTHORITY: @`
3	SUBTASK	T;0	Multiple #798.83	798.83 DESCRIPTION: `The SUBTASK multiple contains a list of subtasks started by the main task.` TECHNICAL DESCR: `The subtask functionality has not been implemented yet. This multiple is reserved for future use.` `WRITE AUTHORITY: @`
4	PROGRESS	P;E1,255	NUMBER	INPUT TRANSFORM: `K:+X'=X!(X>100)!(X<0)!(X?.E1"."4N.N) X` LAST EDITED: `NOV 14, 2002` HELP-PROMPT: `Type a Number between 0 and 100, 3 Decimal Digits.` DESCRIPTION: `The PROGRESS field stores the percentage of completion of the task. If the task does not explicitly support this feature, the field is always empty.` TECHNICAL DESCR: `The task can update the value of this field using the parameter of the $$LOOP^RORTSK01 function that should be called in the main loop of the task.` `DELETE AUTHORITY: @` `WRITE AUTHORITY: @`
5	ACTION	A;E1,255	SET	'1' FOR Suspend; '2' FOR Stop; LAST EDITED: `NOV 14, 2002` DESCRIPTION: `Values of the ACTION field control the task behavior. You can either suspend/resume or stop the task` TECHNICAL DESCR: `Please do not modify this field directly. Use the $$DEQUEUE^RORTSK function to stop the task, and the $$SUSPEND^RORTSK02 and $$RESUME^RORTSK02 functions to suspend/resume it.` `The task can also be stopped using the Stop task option of the Taskman User menu (see the User's Toolbox menu).` `DELETE AUTHORITY: @` `WRITE AUTHORITY: @`
7	REPORT ELEMENT	RI;0	POINTER Multiple #798.87	798.87 LAST EDITED: `NOV 29, 2002` DESCRIPTION: `The REPORT ELEMENT multiple stores the output of the 'Report' task (see the TYPE field).` `A report is stored as a tree of XML elements. Each element can contain some text, a single-line value or no value at all. Several attributes can be associated with the element. Valid element and attribute names are stored` `in the ROR XML ELEMENT and ROR XML ATTRIBUTE files.` `Storing the XML document in this sparse format allows to perform sorting on predefined fields (on the server) when the report is created.` `If you do not need this functionality, you can generate a report as a single element (in terms of this multiple) that contains the whole XML document.` TECHNICAL DESCR: `Please do not edit this multiple directly. Use the API defined in the RORTSK1 routine instead.` `WRITE AUTHORITY: @` INDEXED BY: `PARENT & REPORT ELEMENT & SORT BY (APSR), PARENT (APSV0), PARENT & REPORT ELEMENT & VALUE & SORT BY (APSV1)`

External References

Name	Field # of Occurrence
^%DT	.07+1, 2.02+1
NOW^%DTC	.01(XREF 2S)
^DICR	.01(XREF 2n1.4), .01(XREF 3S)

Global Variables Directly Accessed

Name	Line Occurrences (* Changed, ! Killed)
^DD(798.8	.01(XREF 2S), .01(XREF 3S), .01(XREF 3n1.1)
^DIC(3.1 - [#3.1]	.01(XREF 3n1.1)
^RORDATA(798.7 - [#798.7]	2.03(XREF 1S), 2.03(XREF 1K)
^RORDATA(798.8 - [#798.8]	.01(XREF 1S), .01(XREF 1K), .01(XREF 2S), .01(XREF 2n1.3), .01(XREF 2n1.4), .01(XREF 3S), .01(XREF 3n1.3), .07(XREF 1S), .07(XREF 1K), .08(XREF 1S) , .08(XREF 1K)
^VA(200 - [#200]	.01(XREF 3n1.1), .01(XREF 3n1.3)

Naked Globals

Name	Field # of Occurrence
^(	.01(XREF 3n1.1)
^(0	.01(XREF 2S), .01(XREF 2n1.3), .01(XREF 2n1.4), .01(XREF 3S), .01(XREF 3n1.1), .01(XREF 3n1.3)

Local Variables

Legend:

>>	Not killed explicitly
*	Changed
!	Killed
~	Newed

Name	Field # of Occurrence
%	.01(XREF 2S), .01(XREF 3n1.1)
>> %DT	.07+1, 2.02+1
%H	.01(XREF 2S)
%I	.01(XREF 2S)
>> D0	.01(XREF 2S), .01(XREF 2n1.3), .01(XREF 3S), .01(XREF 3n1.3)
>> DA	.01(XREF 1S), .01(XREF 1K), .01(XREF 2n1.3), .01(XREF 3n1.3), .07(XREF 1S), .07(XREF 1K), .08(XREF 1S), .08(XREF 1K), 2.03(XREF 1S), 2.03(XREF 1K)
>> DIG	.01(XREF 2n1.4), .01(XREF 3S)
>> DIH	.01(XREF 2n1.4), .01(XREF 3S)
>> DINUM	.01+1*
>> DIU	.01(XREF 2S), .01(XREF 3S)
DIV	.01(XREF 2S), .01(XREF 2n1.3), .01(XREF 2n1.4), .01(XREF 3S), .01(XREF 3n1.1), .01(XREF 3n1.3)
DIV(0	.01(XREF 2n1.3), .01(XREF 2n1.4), .01(XREF 3S), .01(XREF 3n1.3)
DUZ	.01(XREF 3n1.1)
U	.01(XREF 2S), .01(XREF 2n1.3), .01(XREF 2n1.4), .01(XREF 3S), .01(XREF 3n1.1), .01(XREF 3n1.3)
X	.01+1!, .01(XREF 1S), .01(XREF 1K), .01(XREF 2S), .01(XREF 2n1.3), .01(XREF 2n1.4), .01(XREF 3S), .01(XREF 3n1.1), .01(XREF 3n1.3), .01(XREF 3n49.2) , .05+1!, .07+1!, .07(XREF 1S), .07(XREF 1K), .08(XREF 1S), .08(XREF 1K), 1.01+1!, 2.02+1!, 2.03(XREF 1S), 2.03(XREF 1K) , 2.04+1!, 4+1!
Y	.01(XREF 2S), .01(XREF 3S), .07+1, 2.02+1
Y(0	.01(XREF 2n1.3), .01(XREF 3n1.3)
Y(1	.01(XREF 2S), .01(XREF 2n1.3), .01(XREF 3S), .01(XREF 3n1.3)

Info | Desc | Directly Accessed By Routines | Accessed By FileMan Db Calls | Pointer To FileMan Files | Fields | External References | Global Variables Directly Accessed | Naked Globals | Local Variables | All