STANDARD DATA DICTIONARY #3.51 -- SPOOL DOCUMENT FILE 3/24/25 PAGE 1
STORED IN ^XMB(3.51, *** NO DATA STORED YET *** SITE: WWW.BMIRWIN.COM UCI: VISTA,VISTA (VERSION 8.0)
DATA NAME GLOBAL DATA
ELEMENT TITLE LOCATION TYPE
-----------------------------------------------------------------------------------------------------------------------------------
This file holds the name of spool documents created by the Kernel spooler (%ZIS4) for all operating systems. It does not hold the
text of the documents themselves. That text is first spooled to spool space, then moved into the ^XMB global as a mail message.
This file does, however, provide the mechanism for securing spool space for and during spooling. It is cross-referenced by name,
spool number, user, and mail message.
FILE SCREEN (SCR-node) : I $D(DUZ)=11,$D(^XMB(3.51,"AOK",Y,DUZ))!$D(^XUSEC("XUMGR",DUZ))
DD ACCESS: @
RD ACCESS: @
WR ACCESS: @
LAYGO ACCESS: @
APPLICATION GROUP(S): XU, ZIS
POINTED TO BY: ENTRY field (#.01) of the SPOOL DATA File (#3.519)
CROSS
REFERENCED BY: USER(ADUZ), SPOOL DATA(AM), USER(AOK), OTHER AUTHORIZED USERS(AOK2), NAME(B), SPOOL NUMBER(C)
3.51,.01 NAME 0;1 FREE TEXT (Required)
INPUT TRANSFORM: K:$L(X)>80!($L(X)<3)!'(X'?1P.E)!(X'?.ANP)!(X?1.2E1"-".E) X
LAST EDITED: MAR 04, 1988
HELP-PROMPT: Answer must be 3-80 characters in length, and not look like a TERM. TYPE.
DESCRIPTION: This field holds the name of the spool document. To avoid device handler confusion, the name of
the spool document must not look like the name of a terminal type, e.g. C-VT100, since either name
might be contained in a response to the device prompt.
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
CROSS-REFERENCE: 3.51^B
1)= S ^XMB(3.51,"B",$E(X,1,63),DA)=""
2)= K ^XMB(3.51,"B",$E(X,1,63),DA)
3.51,1 SPOOL NUMBER 0;2 FREE TEXT
INPUT TRANSFORM: K:$L(X)>30!($L(X)<1) X
LAST EDITED: MAR 15, 1989
HELP-PROMPT: Answer must be 1-30 characters in length.
DESCRIPTION:
This is a system-assigned identification number for spool documents.
UNEDITABLE
CROSS-REFERENCE: 3.51^C
1)= S ^XMB(3.51,"C",$E(X,1,60),DA)=""
2)= K ^XMB(3.51,"C",$E(X,1,60),DA)
3.51,2 STATUS 0;3 SET
'a' FOR Active;
'o' FOR Open;
'r' FOR Ready;
'm' FOR Message;
'p' FOR Printed;
LAST EDITED: MAR 25, 1988
DESCRIPTION:
This is an internal flag to indicate the status of the spool document.
3.51,3 DATE INITIATED 0;4 DATE
INPUT TRANSFORM: S %DT="ETX" D ^%DT S X=Y K:Y<1 X
DESCRIPTION:
This field indicates when a spool document was created as an entry in this Spool Document File.
3.51,4 USER 0;5 POINTER TO NEW PERSON FILE (#200)
LAST EDITED: AUG 22, 1989
DESCRIPTION: This field holds a pointer to the New Person File to indicate the identity of the person creating
the spool document.
CROSS-REFERENCE: 3.51^AOK^MUMPS
1)= S ^XMB(3.51,"AOK",DA,X)=""
2)= K ^XMB(3.51,"AOK",DA,X)
The 'AOK' cross-reference identifies who has access to this document. The creater of the document
is automatically assigned access.
CROSS-REFERENCE: 3.51^ADUZ
1)= S ^XMB(3.51,"ADUZ",$E(X,1,30),DA)=""
2)= K ^XMB(3.51,"ADUZ",$E(X,1,30),DA)
The 'ADUZ' cross-reference identifies who is the creator of an individual document.
3.51,5 STARTED 0;6 DATE
INPUT TRANSFORM: S %DT="ETX" D ^%DT S X=Y K:Y<1 X
LAST EDITED: JUL 12, 1984
DESCRIPTION:
This field indicates when spool device activity began.
3.51,6 PRINTED 0;7 DATE
INPUT TRANSFORM: S %DT="ETX" D ^%DT S X=Y K:Y<1 X
LAST EDITED: DEC 03, 1984
DESCRIPTION:
This field indicates when the spool document was printed.
3.51,7 PAGE ATTRIBUTES 0;8 FREE TEXT
INPUT TRANSFORM: K:$L(X)>9!($L(X)<3)!'(X?1.3N1";"1.5N) X
LAST EDITED: DEC 16, 2008
HELP-PROMPT: Answer must be 3-9 characters in length
DESCRIPTION: This field holds the device parameters which were established by the initial device handler call.
These parameters are retained and use when the job is spooled and when the spool document is
printed.
3.51,8 NUMBER OF LINES 0;9 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>9999999)!(X<0)!(X?.E1"."1N.N) X
LAST EDITED: MAY 13, 1988
HELP-PROMPT: Type a Number between 0 and 9999999, 0 Decimal Digits
DESCRIPTION: This field holds a count of the total lines spooled for this spool document. It is used in
conjunction with the limit set in the Kernel Site Parameter File to regulate the amount of spooled
text that users may accumulate.
UNEDITABLE
3.51,9 SPOOL DATA 0;10 POINTER TO SPOOL DATA FILE (#3.519)
INPUT TRANSFORM: S DIC("S")="I 0" D ^DIC K DIC S DIC=DIE,X=+Y K:Y<0 X
LAST EDITED: AUG 01, 1991
HELP-PROMPT: FOR INTERNAL USE ONLY
DESCRIPTION: This field holds a pointer to the Spool File indicating the storage location of the spooled
document.
SCREEN: S DIC("S")="I 0"
EXPLANATION: CAN'T BE ACCESS FROM HERE
UNEDITABLE
CROSS-REFERENCE: 3.51^AM
1)= S ^XMB(3.51,"AM",$E(X,1,30),DA)=""
2)= K ^XMB(3.51,"AM",$E(X,1,30),DA)
3.51,10 INCOMPLETE REPORT INDICATOR 0;11 SET
'1' FOR YES, REPORT IS INCOMPLETE;
LAST EDITED: JUL 31, 1991
HELP-PROMPT: Output only. Set by spool code.
DESCRIPTION: This flag is set buy the spooler code to indicate that not all of the report was restored from the
system spool space.
3.51,21 DEVICE'S 2;0 Multiple #3.5121
DESCRIPTION:
This subfile holds the names of the devices that are being used for despooling (printing).
3.5121,.01 DEVICE 0;1 FREE TEXT
INPUT TRANSFORM: K:$L(X)>30!($L(X)<2) X I '$D(ZISDA) W " Must be called from the Spooler options" K X
LAST EDITED: OCT 24, 1988
HELP-PROMPT: ANSWER MUST BE A VALID DEVICE NAME
DESCRIPTION:
This field holds the name of the device that is being used for despooling (printing).
EXECUTABLE HELP: W !,"Must only be called from the Spooler Options"
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
CROSS-REFERENCE: 3.5121^B
1)= S ^XMB(3.51,DA(1),2,"B",$E(X,1,30),DA)=""
2)= K ^XMB(3.51,DA(1),2,"B",$E(X,1,30),DA)
3.5121,1 COPIES TO PRINT 0;2 NUMBER
Copies to print
INPUT TRANSFORM: K:+X'=X!(X>99)!(X<1)!(X?.E1"."1N.N) X
LAST EDITED: FEB 02, 1988
HELP-PROMPT: Type a Number between 1 and 99, Number of copies needed.
DESCRIPTION: This field holds an indication of the number of copies of the spool document that are to be
despooled.
3.5121,2 CURRENT PAGE 0;3 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>9999)!(X<1)!(X?.E1"."1N.N) X
LAST EDITED: FEB 02, 1988
HELP-PROMPT: Type a Number between 1 and 9999, 0 Decimal Digits
DESCRIPTION:
This field holds an indication of the current page being despooled.
3.5121,3 LINE NUMBER OF CURRENT PAGE 0;4 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>999999)!(X<1)!(X?.E1"."1N.N) X
LAST EDITED: FEB 02, 1988
HELP-PROMPT: Type a Number between 1 and 999999, 0 Decimal Digits
DESCRIPTION:
This field holds an indication of the line number of the current page being despooled.
3.5121,4 FINISH DATE/TIME 0;5 DATE
INPUT TRANSFORM: S %DT="ESTX" D ^%DT S X=Y K:Y<1 X
LAST EDITED: FEB 02, 1988
DESCRIPTION:
This field indicates when the job finished despooling.
3.5121,5 COPIES PRINTED 0;6 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>999)!(X<1)!(X?.E1"."1N.N) X
LAST EDITED: FEB 10, 1989
HELP-PROMPT: Type a Number between 1 and 999, 0 Decimal Digits
DESCRIPTION: This field holds an indication of the actual number of copies of the spool document that have
been printed.
3.51,31 OTHER AUTHORIZED USERS 3;0 POINTER Multiple #3.5131 (Add New Entry without Asking)
DESCRIPTION:
This is a list of other users that my print this spool document.
3.5131,.01 OTHER AUTHORIZED USERS 0;1 POINTER TO NEW PERSON FILE (#200) (Multiply asked)
LAST EDITED: AUG 22, 1989
HELP-PROMPT: Other users who may share this spool document.
CROSS-REFERENCE: 3.5131^B
1)= S ^XMB(3.51,DA(1),3,"B",$E(X,1,30),DA)=""
2)= K ^XMB(3.51,DA(1),3,"B",$E(X,1,30),DA)
CROSS-REFERENCE: 3.51^AOK2^MUMPS
1)= S ^XMB(3.51,"AOK",DA(1),X)=""
2)= K:'$D(^XMB(3.51,"ADUZ",X,DA(1))) ^XMB(3.51,"AOK",DA(1),X)
The 'AOK2' cross-reference set the 'AOK' cross-reference. The 'AOK' cross-reference identifies
who has authorized access to an individual document.
FILES POINTED TO FIELDS
NEW PERSON (#200) USER (#4)
OTHER AUTHORIZED USERS:OTHER AUTHORIZED USERS (#.01)
SPOOL DATA (#3.519) SPOOL DATA (#9)
INPUT TEMPLATE(S):
XU-ZISPL1 MAY 03, 1994@10:04 USER #0
PRINT TEMPLATE(S):
XU-ZISPL-USER DEC 16, 2008@08:37 USER #0 SPOOL DOCUMENT LIST
SORT TEMPLATE(S):
XU-ZISPL-USER DEC 13, 1996@15:43 USER #0
SORT BY: +USER// (USER not null)
FORM(S)/BLOCK(S):