STANDARD DATA DICTIONARY #14.7 -- TASKMAN SITE PARAMETERS FILE                                                    3/24/25    PAGE 1
STORED IN ^%ZIS(14.7,  (1 ENTRY)   SITE: WWW.BMIRWIN.COM   UCI: VISTA,VISTA                                        (VERSION 8.0)   

DATA          NAME                  GLOBAL        DATA
ELEMENT       TITLE                 LOCATION      TYPE
-----------------------------------------------------------------------------------------------------------------------------------
This file should be used by the system manager to tune TaskMan to the site's specific needs.  Entries are identified by the cpu and
volume set, so that parameters can be set differently for different nodes that share a single volume set, etc.  Changes to any of
the fields will automatically cause all accessible Task Managers on the system to update their local copies of the parameters.  


              DD ACCESS: @
              RD ACCESS: @
              WR ACCESS: @
             DEL ACCESS: @
           LAYGO ACCESS: @
           AUDIT ACCESS: @

   APPLICATION GROUP(S): ZT

POINTED TO BY: TM MASTER field (#12) of the TASKMAN SITE PARAMETERS File (#14.7) 
               BOX-VOLUME PAIR field (#.01) of the LISTENER CONFIGURATION sub-field (#18.012) of the FOUNDATIONS SITE PARAMETERS 
                   File (#18.01) 
               BOX-VOLUME PAIR field (#.01) of the VISTALINK LISTENER STARTUP LOG File (#18.04) 
               BOX-VOLUME PAIR field (#.13) of the HLO SYSTEM PARAMETERS File (#779.1) 
               BOX-VOLUME PAIR field (#.16) of the HLO PROCESS REGISTRY File (#779.3) 
               STARTUP NODE field (#400.06) of the HL LOWER LEVEL PROTOCOL PARAMETER File (#869.2) 
               STARTUP NODE field (#400.06) of the HL LOGICAL LINK File (#870) 
               BOX-VOLUME PAIR field (#.01) of the LISTENER sub-field (#8994.17) of the RPC BROKER SITE PARAMETERS File (#8994.1) 
               

CROSS
REFERENCED BY: TASK PARTITION SIZE(AC), TASKMAN JOB LIMIT(AD), TASKMAN HANG BETWEEN NEW JOBS(AE), BOX-VOLUME PAIR(AF), 
               Balance Interval(AG), MIN SUBMANAGER CNT(AH), LOAD BALANCE ROUTINE(AI), BOX-VOLUME PAIR(B)

    LAST MODIFIED: DEC 18,2023@14:42:07

14.7,.01      BOX-VOLUME PAIR        0;1 FREE TEXT (Required) (audited)

              CPU BOX-VOLUME SET PAIR   
              INPUT TRANSFORM:  K:X[""""!($A(X)=45) X I $D(X) K:$L(X)>30!($L(X)<3)!'(X'?1P.E) X
              LAST EDITED:      DEC 18, 2023 
              HELP-PROMPT:      Answer must be 3-30 characters in length. 
              DESCRIPTION:      Your answer should be the  volume set name concatenated with ":" concatenated with the name of the
                                CPU.  
                                 
                                The value for the current process can be found by doing GETENV^%ZOSV and checking the fourth
                                ^-piece of Y.  This allows the TaskMan site parameters to be applied extremely precisely, depending
                                both upon which volume set and cpu which is affected.  

              EXECUTABLE HELP:  D GETENV^%ZOSV W !,"The value for the current account is ",$P(Y,"^",4)
              AUDIT:            YES, ALWAYS
              SOURCE OF DATA:   System manager (from local system configuration).
              DATA DESTINATION: System manager (from local system configuration).
              CROSS-REFERENCE:  14.7^B 
                                1)= S ^%ZIS(14.7,"B",$E(X,1,30),DA)=""
                                2)= K ^%ZIS(14.7,"B",$E(X,1,30),DA)
                                TaskMan uses this cross-reference to lookup environments.  


              CROSS-REFERENCE:  14.7^AF^MUMPS 
                                1)= D ^XUTMG14P
                                2)= Q
                                This cross-reference notifies TaskMan of changes to the field.  



14.7,1        RESERVED               0;2 SET

                                'Y' FOR YES; 
                                'N' FOR NO; 
              LAST EDITED:      MAY 17, 1991 
              DESCRIPTION:
                                Answer YES to activate response time monitoring for processes using this pair of resources.  

              SOURCE OF DATA:   System manager.
              DATA DESTINATION: System manager.

14.7,2        LOG TASKS?             0;3 SET (audited)

                                'Y' FOR YES; 
                                'N' FOR NO; 
              LAST EDITED:      DEC 18, 2023 
              DESCRIPTION:
                                If you answer YES, then tasks will gerenarate entries in the sign-on log file.  

              AUDIT:            YES, ALWAYS
              SOURCE OF DATA:   System manager.
              DATA DESTINATION: System manager.

14.7,3        DEFAULT TASK PRIORITY  0;4 NUMBER (audited)

              INPUT TRANSFORM:  K:+X'=X!(X>10)!(X<1)!(X?.E1"."1N.N) X
              LAST EDITED:      DEC 18, 2023 
              HELP-PROMPT:      Type a Number between 1 and 10, 0 Decimal Digits 
              DESCRIPTION:      Your answer will set the default Kernel priority assigned to tasks.  This value will be overridden
                                only for special options, devices, and tasks.  
                                 
                                If this value is too low, jobs started by TaskMan will be unable to process tasks fast enough to
                                keep up with demand.  7-10 are good values, depending on whether interactive users' priorities are
                                set higher or lower on the local system.  

              AUDIT:            YES, ALWAYS
              SOURCE OF DATA:   System manager.
              DATA DESTINATION: System manager.

14.7,4        TASK PARTITION SIZE    0;5 NUMBER (audited)

              INPUT TRANSFORM:  K:+X'=X!(X>999)!(X<10)!(X?.E1"."1N.N) X
              LAST EDITED:      DEC 18, 2023 
              HELP-PROMPT:      Enter the number of KB (10-999) to set maximum partition size to. 
              DESCRIPTION:      Under MSM only, this field will be used to change the maximum partition size for a JOB.  It will be
                                used by both interactive and Tasked jobs.  
                                 
                                The answer is in K bytes to pass into MSM's %PARTSIZ utility. Check with the 486 team for the
                                latest recommendations.  

              AUDIT:            YES, ALWAYS
              SOURCE OF DATA:   System manager.
              DATA DESTINATION: System manager.
              CROSS-REFERENCE:  14.7^AC^MUMPS 
                                1)= I X]"" D ^XUTMG14P
                                2)= Q
                                This cross-reference notifies TaskMan of changes to the field.  



14.7,5        SUBMANAGER RETENTION TIME 0;6 NUMBER (audited)

              INPUT TRANSFORM:  K:+X'=X!(X>600)!(X<0)!(X?.E1"."1N.N) X
              LAST EDITED:      DEC 18, 2023 
              HELP-PROMPT:      Type a Number between 0 and 600, 0 Decimal Digits 
              DESCRIPTION:      Answer will determine how long submanagers wait for new tasks, in seconds.  
                                 
                                The goal of this field is to reduce the number of JOB commands needed to process a site's tasks. 
                                By keeping old submanagers around to run new tasks, new process creation is severely reduced.  Good
                                values are 300-600 seconds for VAX sites, and 10-50 for others.  

              AUDIT:            YES, ALWAYS
              SOURCE OF DATA:   System manager.
              DATA DESTINATION: System manager.

14.7,6        TASKMAN JOB LIMIT      0;7 NUMBER (Required) (audited)

              INPUT TRANSFORM:  K:+X'=X!(X>9999)!(X<1)!(X?.E1"."1.N) X
              LAST EDITED:      DEC 18, 2023 
              HELP-PROMPT:      Type a number between 1 and 9999, 0 Decimal Digits 
              DESCRIPTION:      If there are more active processes on the system than this number, TaskMan will not create new
                                submanagers to handle tasks.  Task processing will be left to existing submanagers until the number
                                of processes falls back below this number.  
                                 
                                This number should be slightly lower than the Max Signons field of the Kernel Site Parameters file,
                                so that the system manager still has room to sign on when TaskMan is using its greatest number of
                                partitions.  

              AUDIT:            YES, ALWAYS
              SOURCE OF DATA:   System manager.
              DATA DESTINATION: System manager.
              CROSS-REFERENCE:  14.7^AD^MUMPS 
                                1)= I X]"" D ^XUTMG14P
                                2)= Q
                                This cross-reference notifies TaskMan of changes to the field.  



14.7,7        TASKMAN HANG BETWEEN NEW JOBS 0;8 NUMBER (audited)

              INPUT TRANSFORM:  K:+X'=X!(X>10)!(X<0)!(X?.E1"."1N.N) X
              LAST EDITED:      DEC 18, 2023 
              HELP-PROMPT:      Type a Number between 0 and 10, 0 Decimal Digits 
              DESCRIPTION:      Answer will set a delay between the creation of new submanagers, in seconds.  
                                 
                                Such a delay is necessary where the Retention Time is low and task creation cost is high. This
                                prevents the creation of many new submanagers in quick succession from causing a perceivable delay
                                to users.  The number should be the lowest value that prevents the problem.  

              AUDIT:            YES, ALWAYS
              SOURCE OF DATA:   System manager.
              DATA DESTINATION: System manager.
              CROSS-REFERENCE:  14.7^AE^MUMPS 
                                1)= I X]"" D ^XUTMG14P
                                2)= Q
                                This cross-reference notifies TaskMan of changes to the field.  



14.7,8        MODE OF TASKMAN        0;9 SET (Required) (audited)

                                'G' FOR GENERAL PROCESSOR; 
                                'P' FOR PRINT SERVER; 
                                'C' FOR COMPUTE SERVER; 
                                'O' FOR OTHER NON-TASKMAN; 
              LAST EDITED:      DEC 18, 2023 
              DESCRIPTION:      This field describes how TaskMan should act.  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 Processor:  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.  Submanagers started on a G type will process tasks in the Partition Waiting
                                List and the Busy Device Waiting Lists.  
                                 
                                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:  The Manager will not start on a C type.  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.  
                                 
                                Other Non-TaskMan:  Neither the Manager nor the Submanager will run on O types.  Tasks sent from or
                                to a 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 is a required field.",!?5,"Enter '??' for more help.",!
              AUDIT:            YES, ALWAYS

14.7,9        VAX ENVIROMENT FOR DCL 0;10 FREE TEXT (audited)

              INPUT TRANSFORM:  K:$L(X)>12!($L(X)<2) X
              LAST EDITED:      DEC 18, 2023 
              HELP-PROMPT:      Answer must be 2-12 characters in length. 
              DESCRIPTION:      This field only has meaning on OpenVMS systems.  
                                 
                                If this field is empty, then the M JOB command will be used.  
                                 
                                If this field has a value, it will cause TM to SUBMIT submanagers to run from a VMS batch queue
                                with a name of TM$.  
                                 
                                For Cache VMS, Put the VMS NODE name in this field as the BOX:VOLUME field has the configuration
                                name in it.  
                                 
                                For VAX DSM, Put the NAME of the DSM manager that starts the environment.  
                                 
                                TM will submit submanagers to the queue TM$, have this queue assigned to the proper
                                node.  
                                 
                                There are several VMS setups that must be in place before starting to use this method.  The TASKMAN
                                user account and directory, ZTM2WDCL.COM and ZTMS2WDCL.COM, Batch queue TM$, DHCP$TASKMAN
                                logical.  (For DSM use ZTMWDCL.COM and ZTMSWDCL.COM) 
                                 
                                For more information, See the systems management issues section of the taskman chapter in the
                                Kernel systems manual.  

              AUDIT:            YES, ALWAYS

14.7,10       OUT OF SERVICE         0;11 SET (Required)

                                '0' FOR NO; 
                                '1' FOR YES; 
              LAST EDITED:      JAN 18, 1994 
              HELP-PROMPT:      Answer YES to prevent any taskman jobs being sent to this cpu. 
              DESCRIPTION:      This field is used by the TASK Manager to control if any new sub-manager jobs are sent to this
                                Box-Volume Pair.  If the manager gets an error when jobbing to another CPU it will change the flag
                                to mark the Box-Volume as Out of Service.  


14.7,11       MIN SUBMANAGER CNT     0;12 NUMBER (audited)

              INPUT TRANSFORM:  K:+X'=X!(X>99)!(X<0)!(X?.E1"."1N.N) X
              LAST EDITED:      DEC 18, 2023 
              HELP-PROMPT:      Type a Number between 0 and 99, 0 Decimal Digits 
              DESCRIPTION:      This field sets a value that free submanagers will check and not stop if there count doesn't
                                exceed. The manager will check this and start new submangers if the free count is below this value. 
                                If this field is left blank a default value of 1 is used.  

              AUDIT:            YES, ALWAYS
              CROSS-REFERENCE:  14.7^AH^MUMPS 
                                1)= I X]"" D ^XUTMG14P
                                2)= Q
                                3)= This cross-reference notifies TaskMan of changes to the field.


14.7,12       TM MASTER              0;13 POINTER TO TASKMAN SITE PARAMETERS FILE (#14.7) (audited)

              LAST EDITED:      DEC 18, 2023 
              DESCRIPTION:      This field is holds a pointer to the TaskMan Master Box-Volume.  This is only needed if this
                                Box-Volume is mounted on an other configuration and shares the library account with that other 
                                configuration. 

              AUDIT:            YES, ALWAYS

14.7,13       Balance Interval       0;14 NUMBER (audited)

              INPUT TRANSFORM:  K:+X'=X!(X>120)!(X<10)!(X?.E1"."1.N) X
              LAST EDITED:      DEC 18, 2023 
              HELP-PROMPT:      Type a number between 10 and 120, 0 Decimal Digits 
              DESCRIPTION:      This field sets the time interval in seconds that the Task Manager will wait before running the
                                "LOAD BALANCE ROUTINE". If this field in empty a value of 30 will be used.  A lower value will
                                cause more resources to be used calculating the balance. A large value will allow a node to pick-up
                                a lot of work before balancing.  

              AUDIT:            YES, ALWAYS
              CROSS-REFERENCE:  14.7^AG^MUMPS 
                                1)= I X]"" D ^XUTMG14P
                                2)= Q
                                3)= This cross-reference notifies TaskMan of changes to the field.


14.7,21       LOAD BALANCE ROUTINE   2;E1,75 FREE TEXT (audited)

              INPUT TRANSFORM:  K:$L(X)>75!($L(X)<3)!'(X?1"$".1PA.E) X
              LAST EDITED:      DEC 18, 2023 
              HELP-PROMPT:      Answer must be 3-75 characters in length. Funtion, Extrinsic function, External routine. 
              DESCRIPTION:      This field holds the name of a Function, Extrinsic function or External routine call that returns a
                                load rating. If this field contains a value, TaskMan will use this name in preforming Load
                                Balancing.  
                                 
                                Only use Load Balancing if you have two or more CPU's running TM that share the same %ZTSCH global.  
                                 
                                The Load Balancing function must return a value between 1 and 256.  Where: 1 represents a CPU with
                                no capacity for any more work.  
                                       256 represents a CPU that is Idle.  
                                 
                                The only included functions are For VAX DSM it is '$$VXD' and its algorithm is: Capacity left=
                                Available jobs - Active jobs - (4 * Computable jobs) 
                                 
                                For Cache/NT it is '$$CACHE1(constant)' its algorithm is: Capacity left= Available jobs + constant 
                                 
                                For Cache/VMS it is '$$CACHE2(@com-file,logical-name)'.  If the com-file value is set, that
                                com-file will be run each time taskman wants to get the balance value.  The logical-name will
                                default to "VISTA$METRIC" or us the value entered.  The normal way would be to have $$CACHE2() in
                                the field and use the two scripts.  
                                 
                                A script "GET_METRIC.COM" will set the logical "VISTA$METRIC".  This can be run by taskman or from
                                the TM$node batch queue with the script "METRIC_SCHEDULE.COM".  

              AUDIT:            YES, ALWAYS
              CROSS-REFERENCE:  14.7^AI^MUMPS 
                                1)= D ^XUTMG14P
                                2)= D ^XUTMG14P
                                3)= This cross-reference notifies TaskMan of changes to the field.


14.7,31       Auto Delete Tasks      3;1 SET

                                '0' FOR No; 
                                '1' FOR Yes; 
              LAST EDITED:      MAR 13, 2000 
              DESCRIPTION:      This Field is used by the Sub-manager to control if the Sub-manger should set the ZTREQ variable to
                                "@" so a task will be killed when it finishes unless the application modifies ZTREQ.  
                                 
                                Unless there is a need to save the enties in the ^%ZTSK global set this field to YES.  If you are
                                researching task errors you should set to NO untill you have the data you need.  
                                 
                                This data will still be cleaned up by the XUTMK option.  


14.7,32       Manager Startup Delay  3;2 NUMBER

              INPUT TRANSFORM:  K:+X'=X!(X>180)!(X<1)!(X?.E1"."1.N) X
              LAST EDITED:      MAR 13, 2000 
              HELP-PROMPT:      Type a number between 1 and 180, 0 Decimal Digits 
              DESCRIPTION:      This field is used by the Task Manager to control the delay (hang) the manager will do during a
                                START. This field is not used with a RESTART.  
                                 
                                The Manager Startup Delay was hard set at 60 before. After requests to change the delay it has been
                                made a parameter.  
                                 
                                I would think that 5 to 30 would be OK. If you get errors because jobs start running before
                                DDP/Cluster is up that use a larger number.  



      FILES POINTED TO                      FIELDS

TASKMAN SITE PARAMETERS (#14.7)   TM MASTER (#12)



INPUT TEMPLATE(S):

PRINT TEMPLATE(S):

SORT TEMPLATE(S):

FORM(S)/BLOCK(S):