STANDARD DATA DICTIONARY #14.5 -- VOLUME SET FILE 3/24/25 PAGE 1
STORED IN ^%ZIS(14.5, (1 ENTRY) SITE: WWW.BMIRWIN.COM UCI: VISTA,VISTA (VERSION 8.0)
DATA NAME GLOBAL DATA
ELEMENT TITLE LOCATION TYPE
-----------------------------------------------------------------------------------------------------------------------------------
This file describes the volume sets available in the current multiprocessor network. The information pertaining to each volume set
is primarily used by the Kernel, especially TaskMan. The ucis that make up each volume set can be determined by using the
cross-references in the UCI Association Table file.
DD ACCESS: @
RD ACCESS: @
WR ACCESS: @
DEL ACCESS: @
LAYGO ACCESS: @
AUDIT ACCESS: @
APPLICATION GROUP(S): ZT
POINTED TO BY: TASKMAN FILES VOLUME SET field (#6) of the VOLUME SET File (#14.5)
REPLACEMENT VOLUME SET field (#7) of the VOLUME SET File (#14.5)
FROM VOLUME SET field (#1) of the UCI ASSOCIATION File (#14.6)
TO VOLUME SET field (#2) of the UCI ASSOCIATION File (#14.6)
CROSS
REFERENCED BY: VOLUME SET(AC), VOLUME SET(AD), INHIBIT LOGONS?(AE), OUT OF SERVICE?(AE2), INHIBIT LOGONS?(AF), VOLUME SET(B)
LAST MODIFIED: DEC 18,2023@14:42:07
14.5,.01 VOLUME SET 0;1 FREE TEXT (Required) (audited)
INPUT TRANSFORM: K:X[""""!($A(X)=45) X I $D(X) D IT01^XUTMG145
LAST EDITED: DEC 18, 2023
HELP-PROMPT: Answer must be 3-30 characters in length.
DESCRIPTION: Answer should be the name of a volume set. When each cpu can have only one volume set, this is
also the cpu name. Answer will be used in extended global references to reach this volume.
EXECUTABLE HELP: I $D(ZTUNIQUE) W ?5,"Volume set names must be unique." K ZTUNIQUE
AUDIT: YES, ALWAYS
SOURCE OF DATA: System manager (from local system configuration).
DATA DESTINATION: System manager (from local system configuration).
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
CROSS-REFERENCE: 14.5^B
1)= S ^%ZIS(14.5,"B",$E(X,1,30),DA)=""
2)= K ^%ZIS(14.5,"B",$E(X,1,30),DA)
TaskMan uses this cross-reference to lookup volume sets.
CROSS-REFERENCE: 14.5^AC^MUMPS
1)= I X]"" D S01^XUTMG145
2)= Q
This cross-reference updates the cross-references in the UCI Association file whenever a pointed-to
volume set changes.
CROSS-REFERENCE: 14.5^AD^MUMPS
1)= I X]"" D ^XUTMG14P
2)= Q
This cross-reference notifies TaskMan of changes to the field.
14.5,.1 TYPE 0;10 SET (Required) (audited)
Type of Volume Set
'G' FOR GENERAL PURPOSE VOLUME SET;
'P' FOR PRINT SERVER;
'C' FOR COMPUTE SERVER;
'O' FOR OTHER NON-TASKMAN VOLUME SET;
LAST EDITED: DEC 18, 2023
DESCRIPTION: This field describes how TaskMan should treat the volume set. It takes over many of the 486
configuration functions handled by the Out of Order and Replacement Volume Set fields in versions
6.5 and 7.0.
General Purpose Volume Set: The Manager on a G type will usually send tasks back to the volume set
where they were created, except that tasks that explicitly request a different volume set will be
sent where they ask. (Explicit volume set requests are made by using 1) the ZTCPU input variable
to the %ZTLOAD entry point, 2) the CPU (VOL SET) field of the Device file, or 3) the Queued to What
Volume Set field of the Option file.) To transfer tasks TO a G type, TaskMan will use extended
global references to copy the task to the destination Task and Schedule files, and will then remove
the task from this side.
Print Server: On a P type, the Manager will run any task it finds unless the task explicitly
requests a different volume set. Tasks are transferred TO a P type the same as to a G type, and
Submanagers behave the same.
Compute Server: Tasks are transferred to a C type by placing the tasks in the Link Waiting List
and jobbing a Submanager across to that volume set. Submanagers started on a C type will only
process tasks in the Link Waiting List for their volume set.
File Server and Other Non-TaskMan Volume Set: Tasks sent from or to a F or O type will be rejected.
Because of the field's crucial role in guiding TaskMan's behavior, the field is required.
TECHNICAL DESCR: This field is used by the Manager and Submanager as described above. It is also used by the Global
Support Routines to decide which volume sets are likely to have ^%ZTSCH("UPDATE") nodes that need
to be killed to get the Manager to update its parameters.
EXECUTABLE HELP: W !?5,"This field is required.",!?5,"Enter ?? for more help.",!
AUDIT: YES, ALWAYS
WRITE AUTHORITY: @
SOURCE OF DATA: SYSTEM CONFIGURATION
14.5,1 INHIBIT LOGONS? 0;2 SET (audited)
'Y' FOR YES;
'N' FOR NO;
'S' FOR SYSTEM SHUTDOWN;
LAST EDITED: DEC 18, 2023
DESCRIPTION: Answering YES will cause TaskMan to notify Sign-on that logons are now prohibited, and to stop
processing tasks until logons are allowed again.
If set to SYSTEM SHUTDOWN then taskman set this because of a pending shutdown. Taskman will clear
this flag when restarted.
AUDIT: YES, ALWAYS
SOURCE OF DATA: System manager
DATA DESTINATION: System manager
CROSS-REFERENCE: 14.5^AE^MUMPS
1)= I X]"" D ^XUTMG14P
2)= Q
This cross-reference notifies TaskMan of changes to the field.
CROSS-REFERENCE: 14.5^AF^MUMPS
1)= S ^%ZIS(14.5,"LOGON",$P(^%ZIS(14.5,DA,0),U))=("YS"[X)
2)= K ^%ZIS(14.5,"LOGON",$P(^%ZIS(14.5,DA,0),U))
3)= Tells MenuMan, Security, and TaskMan when logons are inhibited.
This cross-reference sets and kills the flag that tells MenuMan, Security, and TaskMan that logons
are inhibited for this volume set. The flag is kept at ^%ZIS(14.5,"LOGON",volume set name).
14.5,2 LINK ACCESS? 0;3 SET (audited)
'Y' FOR YES;
'N' FOR NO;
LAST EDITED: DEC 18, 2023
DESCRIPTION: Answer NO to tell TaskMan that this volume set cannot be accessed by other volume sets using the
local network links.
Tasks that request a volume set without link access are rejected by TaskMan. Such volume sets are
usually PC workstations linked into the larger network. They can access the core computers, but
cannot be accessed themselves.
SCREEN: S DIC("S")="I $S(Y=""Y"":1,1:$P(^%ZIS(14.5,DA,0),U,5)'=""Y"")"
EXPLANATION: Required volume sets must have link access.
AUDIT: YES, ALWAYS
SOURCE OF DATA: System Manager (from local system configuration).
DATA DESTINATION: System Manager (from local system configuration).
14.5,3 OUT OF SERVICE? 0;4 SET (audited)
'Y' FOR YES;
'N' FOR NO;
LAST EDITED: DEC 18, 2023
DESCRIPTION: Answer YES to temporarily prevent tasks from being sent to this volume set.
While a volume set is out of service, tasks that would normally be sent across the local links to
that volume set are either saved until the volume set is back in service, or sent to a replacement
volume set if one is specified.
AUDIT: YES, ALWAYS
SOURCE OF DATA: System manager.
DATA DESTINATION: System manager.
CROSS-REFERENCE: 14.5^AE2^MUMPS
1)= D ^XUTMG14P
2)= Q
3)= This cross-reference notifies TaskMan of changes to the field.
14.5,4 REQUIRED VOLUME SET? 0;5 SET (audited)
'Y' FOR YES;
'N' FOR NO;
LAST EDITED: DEC 18, 2023
DESCRIPTION: Answer YES if TaskMan cannot run without this volume set being accessible.
If a volume set serves the files that the rest of the system needs, it should be a required volume
set. So long as a volume set is required, the normal mechanisms of handling links that are out of
service or dropped are bypassed for that volume set. Instead, TaskMan waits until the link is
restored before processing any more tasks.
SCREEN: S DIC("S")="I $S(Y=""N"":1,1:$P(^%ZIS(14.5,DA,0),U,3)'=""N"")"
EXPLANATION: Required volume sets must have link access.
AUDIT: YES, ALWAYS
SOURCE OF DATA: System manager (from local system configuration).
DATA DESTINATION: System manager (from local system configuration).
14.5,5 TASKMAN FILES UCI 0;6 FREE TEXT (Required) (audited)
INPUT TRANSFORM: K:$L(X)>30!($L(X)<2) X
LAST EDITED: DEC 18, 2023
HELP-PROMPT: Answer must be 2-30 characters in length.
DESCRIPTION: Answer should be the uci that holds the ^%ZTSK and ^%ZTSCH globals. That uci will usually be the
library uci, which is usually the manager uci. Answer should not contain a comma and volume set
name--just the uci name.
AUDIT: YES, ALWAYS
SOURCE OF DATA: System manager (from local system configuration).
DATA DESTINATION: System manager (from local system configuration).
14.5,6 TASKMAN FILES VOLUME SET 0;7 POINTER TO VOLUME SET FILE (#14.5) (audited)
LAST EDITED: DEC 18, 2023
DESCRIPTION: Answer should be the name of the volume set that holds ^%ZTSK and ^%ZTSCH. If that is the current
volume set, you may leave this field blank.
This field will usually be used for mounted volume sets that lack library ucis of their own, and
for VAX sites set up according to the VA cookbook.
AUDIT: YES, ALWAYS
SOURCE OF DATA: System manager (from local system configuration).
DATA DESTINATION: System manager (from local system configuration).
14.5,7 REPLACEMENT VOLUME SET 0;8 POINTER TO VOLUME SET FILE (#14.5) (audited)
LAST EDITED: DEC 18, 2023
DESCRIPTION: Answer should be a volume set to which tasks can be sent if this volume set is unavailable. If
tasks that need this volume set should wait, leave the field blank.
A replacement volume set should be essentially equivalent in features to the current one, since
tasks that would normally run on this one will be running on that one instead. For many volume
sets, no other volume set is equivalent, and tasks should wait for the link to be restored rather
than run elsewhere.
AUDIT: YES, ALWAYS
SOURCE OF DATA: System manager (from local system configuration).
DATA DESTINATION: System manager (from local system configuration).
14.5,8 DAYS TO KEEP OLD TASKS 0;9 NUMBER (audited)
INPUT TRANSFORM: K:+X'=X!(X>14)!(X<0)!(X?.E1"."1N.N) X
LAST EDITED: DEC 18, 2023
HELP-PROMPT: Type a Number between 0 and 14, 0 Decimal Digits
DESCRIPTION: Answer will be used by ZTMQCLEAN option to decide which tasks to delete.
If no answer is given, ZTMQCLEAN will keep the last seven days' tasks.
AUDIT: YES, ALWAYS
SOURCE OF DATA: System manager.
DATA DESTINATION: System manager.
14.5,9 SIGNON/PRODUCTION VOLUME SET 0;11 SET (audited)
'0' FOR No;
'1' FOR Yes;
LAST EDITED: DEC 18, 2023
DESCRIPTION: Enter Yes if this Volume Set has the following properties:
1. Users can sign-on into the Kernel Menu system or the RPC Broker Server
routine is running there.
2. Has a productions UCI which contains application routines.
3. The ^XTMP global is translated.
If you enter Yes the Kernel Installation and Distribution System will be able to move routines to
this Volume Set. The Kernel Menu system will be able to run the Menu Microsurgery and keep menus
updated.
AUDIT: YES, ALWAYS
14.5,10 RE-QUEUES BEFORE UN-SCHEDULE 0;12 NUMBER (audited)
INPUT TRANSFORM: K:+X'=X!(X>99999)!(X<6)!(X?.E1"."1N.N) X
LAST EDITED: DEC 18, 2023
HELP-PROMPT: Type a number between 6 and 99999, the number of re-queue times.
DESCRIPTION: This field holds the number of times that a task to a HFS or SPOOL device will be re-queued for a 5
minute delay before it is un-scheduled. The routine XUTMHR does this work once an hour. It will
send an alert to the user that queued the task. A value of 12 would be an hour and 288 would be a
day.
AUDIT: YES, ALWAYS
FILES POINTED TO FIELDS
VOLUME SET (#14.5) TASKMAN FILES VOLUME SET (#6)
REPLACEMENT VOLUME SET (#7)
INPUT TEMPLATE(S):
PRINT TEMPLATE(S):
SORT TEMPLATE(S):
FORM(S)/BLOCK(S):