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

Info | Desc | Accessed By FileMan Db Calls | Pointed To By FileMan Files | Pointer To FileMan Files | Fields | ICR | All

Print Page as PDF

Global: ^XMB(3.51

Package: Kernel

Global: ^XMB(3.51

Information

FileMan FileNo	FileMan Filename	Package
3.51	SPOOL DOCUMENT	Kernel

Description

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.

Accessed By FileMan Db Calls, Total: 2

Pointed To By FileMan Files, Total: 1

Pointer To FileMan Files, Total: 2

Fields, Total: 13

Field #	Name	Loc	Type	Details
.01	NAME	0;1	FREE TEXT	**********************REQUIRED FIELD********************** 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)`
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)`
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	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.`
4	USER	0;5	POINTER TO NEW PERSON FILE (#200)	NEW PERSON(#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.`
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.`
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.`
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.`
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`
9	SPOOL DATA	0;10	POINTER TO SPOOL DATA FILE (#3.519)	SPOOL DATA(#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)`
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.`
21	DEVICE'S	2;0	Multiple #3.5121	3.5121 DESCRIPTION: `This subfile holds the names of the devices that are being used for despooling (printing).`
31	OTHER AUTHORIZED USERS	3;0	POINTER Multiple #3.5131	3.5131 DESCRIPTION: `This is a list of other users that my print this spool document.`

ICR, Total: 1

Info | Desc | Accessed By FileMan Db Calls | Pointed To By FileMan Files | Pointer To FileMan Files | Fields | ICR | All