STANDARD DATA DICTIONARY #14.4 -- TASKS FILE 3/24/25 PAGE 1
STORED IN ^%ZTSK( (19 ENTRIES) SITE: WWW.BMIRWIN.COM UCI: VISTA,VISTA (VERSION 8.0)
DATA NAME GLOBAL DATA
ELEMENT TITLE LOCATION TYPE
-----------------------------------------------------------------------------------------------------------------------------------
This file describes the TASKMAN's main file of jobs to start. Because TM works on this file from many UCI's it doesn't use FM to
manipulate it. At this point there are no X-refs on this file and there are no fields that can be edited, Use TM options for that.
The file can be searched, sorted and printed. The third piece of the zero node is only updated when the XUTM QCLEAN option runs.
There are some applications that still do there own setting into this global and wipeout the zero node. The storage of the symbol
table is not in a FM compatable format.
DD ACCESS: @
RD ACCESS:
WR ACCESS: ^
DEL ACCESS: @
LAYGO ACCESS: @
AUDIT ACCESS: @
POINTED TO BY: TASK REFERENCED field (#14) of the ERROR EVENTS sub-field (#3.07701) of the ERROR TRAP SUMMARY File (#3.077)
LAST MODIFIED: AUG 15,2019@16:23:40
14.4,.001 NUMBER NUMBER
INPUT TRANSFORM: K:+X'=X!(X>9899999999)!(X<1)!(X?.E1"."1N.N) X
LAST EDITED: MAY 17, 1994
HELP-PROMPT: Type a Number between 1 and 9899999999, 0 Decimal Digits
DESCRIPTION:
This is the TASK number.
WRITE AUTHORITY: ^
14.4,.01 Entry Point 0;1 FREE TEXT (Required)
INPUT TRANSFORM: K:$L(X)>16!($L(X)<1)!'((X?1A.15AN)) X
LAST EDITED: DEC 14, 2015
HELP-PROMPT: Answer must be 1-16 characters in length.
DESCRIPTION:
This is the entry point in the routine to use.
WRITE AUTHORITY: ^
14.4,2 Routine Name 0;2 FREE TEXT (Required)
INPUT TRANSFORM: K:$L(X)>28!($L(X)<1)!'((X?1A.15AN.1"(".E)!(X?1"%".15AN.1"(".E)) X
LAST EDITED: DEC 14, 2015
HELP-PROMPT: Answer must be 1-28 characters in length.
DESCRIPTION:
This is the ROUTINE that should be run when the scheduled time comes.
WRITE AUTHORITY: ^
14.4,3 User 0;3 POINTER TO NEW PERSON FILE (#200) (Required)
LAST EDITED: JUL 05, 1994
DESCRIPTION: This is a pointer to the NEW PERSON file of the person the created the task. It is only valid if
the task was created in this UCI.
WRITE AUTHORITY: ^
14.4,4 Requested UCI 0;4 FREE TEXT
INPUT TRANSFORM: K:$L(X)>8!($L(X)<1) X
LAST EDITED: MAY 18, 1994
HELP-PROMPT: Answer must be 1-8 characters in length.
DESCRIPTION:
This is the UCI that the job requested that the task run in.
WRITE AUTHORITY: ^
14.4,5 Creation Time ($H) 0;5 FREE TEXT
INPUT TRANSFORM: K:$L(X)>12!($L(X)<5)!'(X?5N1","1.5N) X
LAST EDITED: MAY 18, 1994
HELP-PROMPT: Answer must be 5-12 characters in length.
DESCRIPTION:
This is the time that the task was created.
WRITE AUTHORITY: ^
14.4,6 Scheduled Run Time ($H) 0;6 FREE TEXT
INPUT TRANSFORM: K:$L(X)>12!($L(X)<5)!'(X?5N1"%"1.5N) X
LAST EDITED: MAY 31, 1994
HELP-PROMPT: Answer must be 5-12 characters in length.
DESCRIPTION:
This is the time that the task is scheduled to run.
WRITE AUTHORITY: ^
14.4,7 Type of Task 0;7 FREE TEXT
INPUT TRANSFORM: K:$L(X)>1!($L(X)<1) X
LAST EDITED: MAY 18, 1994
HELP-PROMPT: Answer must be 1 character in length.
DESCRIPTION:
This is a flag to tell if it is an option or a routine that is scheduled.
WRITE AUTHORITY: ^
14.4,8 Option Number 0;8 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>9999999)!(X<1)!(X?.E1"."1N.N) X
LAST EDITED: MAY 18, 1994
HELP-PROMPT: Type a Number between 1 and 9999999, 0 Decimal Digits
DESCRIPTION:
This is the IEN of the option to run. It is only valid if the task was created in this UCI.
WRITE AUTHORITY: ^
14.4,9 Option Name 0;9 FREE TEXT
INPUT TRANSFORM: K:$L(X)>30!($L(X)<1) X
LAST EDITED: MAY 18, 1994
HELP-PROMPT: Answer must be 1-30 characters in length.
DESCRIPTION:
This is the name of the option that is scheduled to run.
WRITE AUTHORITY: ^
14.4,10 Creator Name 0;10 FREE TEXT
INPUT TRANSFORM: K:$L(X)>30!($L(X)<2) X
LAST EDITED: MAY 18, 1994
HELP-PROMPT: Answer must be 2-30 characters in length.
DESCRIPTION:
This is the name of the Person that created the task.
WRITE AUTHORITY: ^
14.4,11 Creation UCI 0;11 FREE TEXT
INPUT TRANSFORM: K:$L(X)>8!($L(X)<1) X
LAST EDITED: MAY 18, 1994
HELP-PROMPT: Answer must be 1-8 characters in length.
DESCRIPTION:
This is the UCI that the task was created in.
WRITE AUTHORITY: ^
14.4,12 Creation Volume Set 0;12 FREE TEXT
INPUT TRANSFORM: K:$L(X)>8!($L(X)<1) X
LAST EDITED: MAY 18, 1994
HELP-PROMPT: Answer must be 1-8 characters in length.
DESCRIPTION:
This is the Volume Set that the task was created on.
WRITE AUTHORITY: ^
14.4,13 RESERVED 0;13 FREE TEXT
INPUT TRANSFORM: K:$L(X)>6!($L(X)<6) X
LAST EDITED: JUN 14, 2001
HELP-PROMPT: This is a holder for the string ZTDESC
DESCRIPTION:
This is a place holder field for the string ZTDESC that is placed in this position by the code.
14.4,14 Requested Volume Set 0;14 FREE TEXT
INPUT TRANSFORM: K:$L(X)>8!($L(X)<1) X
LAST EDITED: MAY 18, 1994
HELP-PROMPT: Answer must be 1-8 characters in length.
DESCRIPTION:
This is the Volume Set that was requested for the running of the task.
WRITE AUTHORITY: ^
14.4,15 Priority 0;15 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>10)!(X<1)!(X?.E1"."1N.N) X
LAST EDITED: MAY 27, 1994
HELP-PROMPT: Type a Number between 1 and 10, 0 Decimal Digits
DESCRIPTION: This field is the priority that the task should run at. It is a value passed in by the calling
routine and over-rides the default.
WRITE AUTHORITY: ^
14.4,16 Original Create date ($H) 0;16 FREE TEXT
INPUT TRANSFORM: K:$L(X)>11!($L(X)<5)!'(X?5N1","1.5N) X
LAST EDITED: JUN 14, 2001
HELP-PROMPT: Answer must be 5-11 characters in length.
DESCRIPTION: This field will get the original creation $H when the task is requeued thru the REQ^%ZTLOAD API.
At other times it will be empty.
14.4,21 Original Destination UCI .01;1 FREE TEXT
INPUT TRANSFORM: K:$L(X)>8!($L(X)<1) X
LAST EDITED: MAY 27, 1994
HELP-PROMPT: Answer must be 1-8 characters in length.
DESCRIPTION:
This is the Original Destination UCI that was given.
WRITE AUTHORITY: ^
14.4,22 Original Destination Volume .01;2 FREE TEXT
INPUT TRANSFORM: K:$L(X)>8!($L(X)<1) X
LAST EDITED: MAY 27, 1994
HELP-PROMPT: Answer must be 1-8 characters in length.
DESCRIPTION:
This field holds the Original Destination Volume.
WRITE AUTHORITY: ^
14.4,31 Current Destination UCI .02;1 FREE TEXT
INPUT TRANSFORM: K:$L(X)>8!($L(X)<1) X
LAST EDITED: MAY 27, 1994
HELP-PROMPT: Answer must be 1-8 characters in length.
DESCRIPTION:
This field holds the Current Destination UCI.
WRITE AUTHORITY: ^
14.4,32 Current Destination Volume Set .02;2 FREE TEXT
INPUT TRANSFORM: K:$L(X)>8!($L(X)<1) X
LAST EDITED: MAY 27, 1994
HELP-PROMPT: Answer must be 1-8 characters in length.
DESCRIPTION:
This field holds the Current Destination Volume Set.
WRITE AUTHORITY: ^
14.4,33 Hop Count .02;3 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>99)!(X<0)!(X?.E1"."1N.N) X
LAST EDITED: JAN 23, 2003
HELP-PROMPT: Type a Number between 0 and 99, 0 Decimal Digits
DESCRIPTION: This field is used by Taskmanager to keep track of the number of times that a task is moved to a
new system trying to start it. After 3 hops taskman will reject the task. This will help keep it
from filling up a disk.
14.4,41 Task Description .03;E1,240 FREE TEXT
INPUT TRANSFORM: K:$L(X)>240!($L(X)<1) X
LAST EDITED: MAY 27, 1994
HELP-PROMPT: Answer must be 1-240 characters in length.
DESCRIPTION:
This field holds the task description that was given by the creating application.
WRITE AUTHORITY: ^
14.4,42 Schedule Time Seconds .04;1 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>9999999999)!(X<86400)!(X?.E1"."1N.N) X
LAST EDITED: MAR 07, 2000
HELP-PROMPT: Type a Number between 86400 and 9999999999, 0 Decimal Digits
DESCRIPTION:
This field holds the Scheduled run time in seconds. It is value is $$H3^%ZTM().
14.4,51 Status Code .1;1 FREE TEXT
INPUT TRANSFORM: K:$L(X)>1!($L(X)<1) X
LAST EDITED: MAY 31, 1994
HELP-PROMPT: Answer must be 1 character in length.
DESCRIPTION:
This is a status code to show that last know state of the task.
WRITE AUTHORITY: ^
14.4,52 Last Update $H .1;2 FREE TEXT
INPUT TRANSFORM: K:$L(X)>12!($L(X)<5)!'(X?5.6N1","1.5N) X
LAST EDITED: MAY 27, 1994
HELP-PROMPT: Answer must be 5-12 characters in length.
DESCRIPTION:
This field holds the $H date when the status code was last updated.
WRITE AUTHORITY: ^
14.4,53 Status Notes .1;3 FREE TEXT
INPUT TRANSFORM: K:$L(X)>50!($L(X)<1) X
LAST EDITED: MAY 27, 1994
HELP-PROMPT: Answer must be 1-50 characters in length.
DESCRIPTION:
This field holds and text string that was included to expaned the status code.
WRITE AUTHORITY: ^
14.4,54 Job .1;4 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>999999999)!(X<0)!(X?.E1"."1N.N) X
LAST EDITED: JAN 23, 2003
HELP-PROMPT: Type a Number between 0 and 999999999, 0 Decimal Digits
DESCRIPTION: This field holds the $JOB value for the process that ran the task.
14.4,59.1 Stop Flag .1;10 FREE TEXT
INPUT TRANSFORM: K:$L(X)>1!($L(X)<1) X
LAST EDITED: MAY 27, 1994
HELP-PROMPT: Answer must be 1 character in length.
DESCRIPTION: This field holds the flag that indicates that the user has asked
the task to stop.
WRITE AUTHORITY: ^
14.4,59.8 Remember Untill .1;8 FREE TEXT
INPUT TRANSFORM: K:$L(X)>11!($L(X)<5)!'(X?1.N.1",".5N) X
LAST EDITED: MAR 13, 1995
HELP-PROMPT: Answer must be a $H date/time.
DESCRIPTION: This field holds the $Horolog value for the date to remember the task untill. The task cleanup
routine will not remove the task record untill after this date.
14.4,61 Message to User .11;E1,240 FREE TEXT
INPUT TRANSFORM: K:$L(X)>240!($L(X)<1) X
LAST EDITED: MAY 27, 1994
HELP-PROMPT: Answer must be 1-240 characters in length.
DESCRIPTION:
This field holds and message that the task sends back to the used when checking the stop flag.
WRITE AUTHORITY: ^
14.4,71 Error Count .12;1 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>5)!(X<0)!(X?.E1"."1N.N) X
LAST EDITED: FEB 03, 1995
HELP-PROMPT: Type a Number between 0 and 5, 0 Decimal Digits
DESCRIPTION: This field holds a count of the retries if the sub-manager gets and error while setting up the
task. The current limit is 5 before the sub-manager stops trying.
WRITE AUTHORITY: ^
14.4,72 Error $H .12;2 FREE TEXT
INPUT TRANSFORM: K:$L(X)>12!($L(X)<5) X
LAST EDITED: MAY 27, 1994
HELP-PROMPT: Answer must be 5-12 characters in length.
DESCRIPTION:
This field holds the $H value of when an eror occured.
WRITE AUTHORITY: ^
14.4,73 Error Message .12;3 FREE TEXT
INPUT TRANSFORM: K:$L(X)>200!($L(X)<1) X
LAST EDITED: FEB 03, 1995
HELP-PROMPT: Answer must be 1-200 characters in length.
DESCRIPTION:
This field holds and OS error message if any error occurs.
14.4,81 Device IOP value .2;1 FREE TEXT
INPUT TRANSFORM: K:$L(X)>45!($L(X)<1) X
LAST EDITED: MAY 27, 1994
HELP-PROMPT: Answer must be 1-45 characters in length.
DESCRIPTION:
This field holds the string that will be passed to %ZIS in the IOP variable.
WRITE AUTHORITY: ^
14.4,82 $IO value .2;2 FREE TEXT
INPUT TRANSFORM: K:$L(X)>45!($L(X)<1) X
LAST EDITED: MAY 27, 1994
HELP-PROMPT: Answer must be 1-45 characters in length.
DESCRIPTION:
This field holds the resolved $IO value that was returned from %ZIS.
WRITE AUTHORITY: ^
14.4,83 Device Type .2;3 FREE TEXT
INPUT TRANSFORM: K:$L(X)>5!($L(X)<1) X
LAST EDITED: MAY 27, 1994
HELP-PROMPT: Answer must be 1-5 characters in length.
DESCRIPTION:
This field holds the device type that was returned from %ZIS.
WRITE AUTHORITY: ^
14.4,84 Device Sub-Type .2;4 FREE TEXT
INPUT TRANSFORM: K:$L(X)>45!($L(X)<1) X
LAST EDITED: MAY 27, 1994
HELP-PROMPT: Answer must be 1-45 characters in length.
DESCRIPTION:
This field holds the Terminal Type value returned from %ZIS.
WRITE AUTHORITY: ^
14.4,85 Device %IS modifier .2;5 FREE TEXT
INPUT TRANSFORM: K:$L(X)>5!($L(X)<1) X
LAST EDITED: MAY 27, 1994
HELP-PROMPT: Answer must be 1-5 characters in length.
DESCRIPTION:
This field holds any modifieds to the %ZIS call.
WRITE AUTHORITY: ^
14.4,86 Host File Address .2;6 FREE TEXT
INPUT TRANSFORM: K:$L(X)>45!($L(X)<1) X
LAST EDITED: MAY 27, 1994
HELP-PROMPT: Answer must be 1-45 characters in length.
DESCRIPTION:
If the device requested is a Host File then this field holds the name of the Host file.
WRITE AUTHORITY: ^
14.4,87 Sync Flag .2;7 FREE TEXT
INPUT TRANSFORM: K:$L(X)>30!($L(X)<1) X
LAST EDITED: MAY 27, 1994
HELP-PROMPT: Answer must be 1-30 characters in length.
DESCRIPTION: This field holds the Sync Flag that will be used to control other tasks with the same Sync Flag.
If one task with a Sync Flag doesn't finish properly other tasks with the same Sync Flag will be
prevented from running.
WRITE AUTHORITY: ^
14.4,88 IO Reschedule Count .2;8 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>99)!(X<0)!(X?.E1"."1N.N) X
LAST EDITED: MAR 07, 2000
HELP-PROMPT: Type a Number between 0 and 99, 0 Decimal Digits
DESCRIPTION: This field holds a count of the number of times a task has been re-Scheduled because the HFS or SPL
type device has been busy. This can be used to find tasks that are looping because of a bad
device.
14.4,91 Device file entry .21;1 POINTER TO DEVICE FILE (#3.5)
LAST EDITED: MAY 27, 1994
DESCRIPTION:
This field holds the IEN of the device that was selected.
WRITE AUTHORITY: ^
14.4,95 Device parameters .25;1 FREE TEXT
INPUT TRANSFORM: K:$L(X)>45!($L(X)<1) X
LAST EDITED: MAY 27, 1994
HELP-PROMPT: Answer must be 1-45 characters in length.
DESCRIPTION:
This field holds other device parameters.
WRITE AUTHORITY: ^
14.4,96 Hunt Group Name .26;1 FREE TEXT
INPUT TRANSFORM: K:$L(X)>30!($L(X)<1) X
LAST EDITED: MAY 27, 1994
HELP-PROMPT: Answer must be 1-30 characters in length.
DESCRIPTION:
This field holds name of the hunt group that the device is in.
WRITE AUTHORITY: ^
14.4,101 ROUTINE ; COMPUTED
MUMPS CODE: S Y(14.4,101,1)=$S($D(^%ZTSK(D0,0)):^(0),1:"") S X=$P(Y(14.4,101,1),U,1)_"^",Y(14.4,101,2)=X S X=$P
(Y(14.4,101,1),U,2),Y=X,X=Y(14.4,101,2),X=X_Y
ALGORITHM: (Entry Point)_"^"_(Routine Name)
14.4,105 Creation DT ; COMPUTED
MUMPS CODE: S X=$$HTE^XLFDT($P($G(^%ZTSK(D0,0)),U,5),"2F")
ALGORITHM: XLFDTHTE(#5,"2F")
DESCRIPTION:
Convert the creation $H into printable format.
14.4,106 Scheduled Run DT ; COMPUTED
MUMPS CODE: S X=$$HTE^XLFDT($P($G(^%ZTSK(D0,0)),U,6),"2F")
ALGORITHM: XLFDTHTE(#6,"2F")
DESCRIPTION:
Convert the scheduled run $H to printable format.
14.4,152 Status DT ; COMPUTED
MUMPS CODE: S X=$$HTE^XLFDT($P($G(^%ZTSK(D0,.1)),U,2),"2F")
ALGORITHM: XLFDTHTE(#52,"2F")
DESCRIPTION:
Convert the status $H to printable format.
FILES POINTED TO FIELDS
DEVICE (#3.5) Device file entry (#91)
NEW PERSON (#200) User (#3)
INPUT TEMPLATE(S):
PRINT TEMPLATE(S):
SORT TEMPLATE(S):
FORM(S)/BLOCK(S):