Home   Package List   Routine Alphabetical List   Global Alphabetical List   FileMan Files List   FileMan Sub-Files List   Package Component Lists   Package-Namespace Mapping  
Info |  Desc |  Directly Accessed By Routines |  Accessed By FileMan Db Calls |  Fields |  External References |  Global Variables Directly Accessed |  Local Variables  | All
Print Page as PDF
Global: ^KMPV(8969

Package: Capacity Management

Global: ^KMPV(8969


Information

FileMan FileNo FileMan Filename Package
8969 VSM CONFIGURATION Capacity Management

Description

Directly Accessed By Routines, Total: 8

Package Total Routines
Capacity Management 8 KMPPS44    KMPUTLW    KMPUTLW2    KMPVCBG    KMPVCCFG    KMPVCSRV    KMPVRUN    ^KMPV(8969

Accessed By FileMan Db Calls, Total: 3

Package Total Routines
Capacity Management 3 KMPUTLW2    KMPVCCFG    KMPVCSRV    

Fields, Total: 25

Field # Name Loc Type Details
.01 MONITOR KEY 0;1 FREE TEXT
************************REQUIRED FIELD************************

  • INPUT TRANSFORM:  K:$L(X)>4!($L(X)<2)!'(X'?1P.E) X
  • LAST EDITED:  DEC 02, 2014
  • HELP-PROMPT:  Answer must be 2-4 characters in length.
  • DESCRIPTION:  
    Two to four Letter acronym used to identify specific monitor.
  • CROSS-REFERENCE:  8969^B
    1)= S ^KMPV(8969,"B",$E(X,1,30),DA)=""
    2)= K ^KMPV(8969,"B",$E(X,1,30),DA)
.02 ONOFF 0;2 SET
  • '1' FOR ON;
  • '0' FOR OFF;

  • LAST EDITED:  JUL 06, 2015
  • HELP-PROMPT:  Enter 'ON' to start monitor or 'OFF' to stop monitor from running.
  • DESCRIPTION:  
    Flag used to stop or continue monitor collection.
.03 FULL NAME 0;3 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>40!($L(X)<4) X
  • LAST EDITED:  DEC 02, 2014
  • HELP-PROMPT:  Answer must be 4-40 characters in length.
  • DESCRIPTION:  
    Descriptive name for specific monitor. Usually related to the MonitorKey. Ex. VTCM = VistA Timed Collection Monitor.
.04 VERSION 0;4 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>100)!(X<1)!(X?.E1"."3.N) X
  • LAST EDITED:  DEC 02, 2014
  • HELP-PROMPT:  Type a number between 1 and 100, 2 decimal digits.
  • DESCRIPTION:  
    Current version of VSM software.
.05 VERSION INSTALL DATE 0;5 DATE

  • INPUT TRANSFORM:  S %DT="ESTX" D ^%DT S X=Y K:3140923>X X
  • LAST EDITED:  DEC 02, 2014
  • HELP-PROMPT:  Type a date not earlier than SEP 23, 2014.
  • DESCRIPTION:  
    Date current version of software was installed.
1.01 DAYS TO KEEP DATA 1;1 NUMBER
************************REQUIRED FIELD************************

  • INPUT TRANSFORM:  K:+X'=X!(X>7)!(X<3)!(X?.E1"."1.N) X
  • LAST EDITED:  DEC 02, 2014
  • HELP-PROMPT:  Type a number between 3 and 7, 0 decimal digits.
  • DESCRIPTION:  Number of days that unsent data will be allowed to remain in ^KMPTMP("KMPV" before the purge routine kills it. Limited to 3-7 days. Data older than this value will be deleted regardless of reason it has not been sent to
    the national database in order to assure global does not grow unchecked.
1.02 COLLECTION INTERVAL 1;2 NUMBER
************************REQUIRED FIELD************************

  • INPUT TRANSFORM:  K:+X'=X!(X>720)!(X<5)!(X?.E1"."1.N) X
  • LAST EDITED:  FEB 26, 2018
  • HELP-PROMPT:  Type a number between 5 and 720, 0 decimal digits.
  • DESCRIPTION:  The number in minutes used to gather or aggregate metrics. Monitors that collect metrics on a periodic basis will use this value to wait between collects. Monitors that collect data continuously will use this value for
    aggregation of metrics.
1.03 CACHE DAILY TASK 1;3 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>25!($L(X)<3) X
  • LAST EDITED:  JUL 06, 2015
  • HELP-PROMPT:  Answer must be 3-25 characters in length.
  • DESCRIPTION:  The name of the routine, if applicable, to start each days collection. The Cache' Task Manager will call the RUN linetag of this routine at the start of every day. This allows collection tasks to run on each node of a
    VistA system - front end and back end.
1.04 ALLOW TEST SYSTEM 1;4 SET
  • '1' FOR YES;
  • '0' FOR NO;

  • LAST EDITED:  JUL 06, 2015
  • HELP-PROMPT:  Enter 'YES' to allow monitor to run on a test system. Otherwise monitor will exit if the current UCI is not set to 'PROD' per ^%ZOSF("UCI").
  • DESCRIPTION:  
    If set to 'Yes' this will allow the monitor to run on test systems. Otherwise monitor will exit if the current UCI is not set as 'PROD' per ^%ZOSF("UCI").
1.05 HTTP REQUEST MAX LENGTH 1;5 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>10000000)!(X<0)!(X?.E1"."1.N) X
  • LAST EDITED:  NOV 09, 2023
  • HELP-PROMPT:  Type a number between 0 and 10000000, 0 decimal digits.
  • DESCRIPTION:  
    This number represents the maximum number of characters that can be sent in a single HTTP request body.
1.06 MONITOR START DELAY 1;6 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>3600)!(X<0)!(X?.E1"."1.N) X
  • LAST EDITED:  SEP 21, 2023
  • HELP-PROMPT:  Type a number between 0 and 3600, 0 decimal digits. Enter the number of seconds by which a monitor start may be delayed.
  • DESCRIPTION:  
    This number represents the maximum number of seconds to delay starting the VSM monitors. The purpose is to lower the arrival rate of HTTP messages at the receiving application.
1.07 TASKMAN OPTION 1;7 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>35!($L(X)<1) X
  • LAST EDITED:  DEC 02, 2014
  • HELP-PROMPT:  Answer must be 1-35 characters in length.
  • DESCRIPTION:  
    The OPTION file entry used by TaskMan to schedule the daily background jobs.
1.08 START PERFMON 1;8 SET
  • '1' FOR True;
  • '0' FOR False;

  • LAST EDITED:  OCT 18, 2019
  • HELP-PROMPT:  1=Auto Start Perfmon 0=Do not start Perfmon
  • DESCRIPTION:  The routine KMPVRUN executes daily immediately after midnight. If START PERFMON is set to 1 then this routine will attempt to start the Performance Monitor if it is not running. If START PERFMON is set to 0 this section of
    code will be skipped.
1.09 ENCRYPT 1;9 SET
  • '1' FOR YES;
  • '0' FOR NO;

  • LAST EDITED:  FEB 14, 2020
  • HELP-PROMPT:  Choose YES to send using SSL/TSL
  • DESCRIPTION:  
    If set to 1 (YES) then VSM HTTP requests will be sent using SSL/TLS encryption (HTTPS). If set to 0 (NO) then HTTP requests will be sent without SSL/TLS encryption (HTTP).
2.01 LAST START TIME 2;1 DATE

  • INPUT TRANSFORM:  S %DT="ESTXR" D ^%DT S X=Y K:X<1 X
  • LAST EDITED:  DEC 02, 2014
  • HELP-PROMPT:  (No range limit on date)
  • DESCRIPTION:  
    Time last TaskMan task was started for a specific monitor.
2.02 LAST STOP TIME 2;2 DATE

  • INPUT TRANSFORM:  S %DT="ESTXR" D ^%DT S X=Y K:X<1 X
  • LAST EDITED:  DEC 02, 2014
  • HELP-PROMPT:  (No range limit on date)
  • DESCRIPTION:  
    Time last TaskMan task completed for a specific monitor.
2.03 LAST RUN TIME 2;3 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>3600)!(X<0)!(X?.E1"."1N.N) X
  • LAST EDITED:  DEC 02, 2014
  • HELP-PROMPT:  Type a number between 0 and 3600, 0 decimal digits.
  • DESCRIPTION:  
    Time in seconds from start to completion of most recent run for a specific monitor TaskMan task.
3.01 NATIONAL DATA EMAIL ADDRESS 3;1 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>50!($L(X)<10) X
  • LAST EDITED:  JUL 06, 2015
  • HELP-PROMPT:  Answer must be 10-50 characters in length.
  • DESCRIPTION:  
    Email address (VistA MailMan) to which daily data collections are sent.
3.02 NATIONAL SUPPORT EMAIL ADDRESS 3;2 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>50!($L(X)<10) X
  • LAST EDITED:  JUL 06, 2015
  • HELP-PROMPT:  Answer must be 10-50 characters in length.
  • DESCRIPTION:  
    Email address (VistA MailMan) where emails are sent informing support staff of configuration changes or potential problems.
3.03 VSM CFG EMAIL ADDRESS 3;3 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>50!($L(X)<10) X
  • LAST EDITED:  JUL 06, 2015
  • HELP-PROMPT:  Answer must be 10-50 characters in length.
  • DESCRIPTION:  
    Email address (VistA MailMan) were local configuration changes are sent to update the national database.
3.04 LOCAL SUPPORT EMAIL ADDRESS 3;4 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>30!($L(X)<10) X
  • LAST EDITED:  JUL 06, 2015
  • HELP-PROMPT:  Answer must be 10-30 characters in length.
  • DESCRIPTION:  
    Local email address (Vista MailMan) used for inform local support staff of configuration changes or potential problems.
4.01 NATIONAL IP ADDRESS 4;1 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>15!($L(X)<7) X
  • LAST EDITED:  MAY 24, 2019
  • HELP-PROMPT:  Answer must be 7-15 characters in length.
  • DESCRIPTION:  
    This field holds the IP address of the national system receiving VSM metric data transmissions.
4.02 NATIONAL FQDN 4;2 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>70!($L(X)<10) X
  • LAST EDITED:  AUG 06, 2019
  • HELP-PROMPT:  Answer must be 10-70 characters in length.
  • DESCRIPTION:  
    This holds the fully qualified domain name of the service receiving metric data from VSM.
4.03 NATIONAL PORT 4;3 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>99999)!(X<0)!(X?.E1"."1.N) X
  • LAST EDITED:  MAY 24, 2019
  • HELP-PROMPT:  Type a number between 0 and 99999, 0 decimal digits.
  • DESCRIPTION:  
    This contains the port number of the national service receiving VSM metrics. This field is only used if the standard port 80 for http and port 443 for https are not to be used.
4.04 APIKEY 4;4 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>70!($L(X)<1) X
  • LAST EDITED:  OCT 03, 2019
  • HELP-PROMPT:  Answer must be 1-70 characters in length.
  • DESCRIPTION:  
    Header key for AWS API Gateway.

External References

Name Field # of Occurrence
^%DT .05+1, 2.01+1, 2.02+1

Global Variables Directly Accessed

Name Line Occurrences  (* Changed,  ! Killed)
^KMPV(8969 - [#8969] .01(XREF 1S), .01(XREF 1K)

Local Variables

Legend:

>> Not killed explicitly
* Changed
! Killed
~ Newed

Name Field # of Occurrence
>> %DT .05+1*, 2.01+1*, 2.02+1*
>> DA .01(XREF 1S), .01(XREF 1K)
X .01+1!, .01(XREF 1S), .01(XREF 1K), .03+1!, .04+1!, .05+1*!, 1.01+1!, 1.02+1!, 1.03+1!, 1.05+1!
, 1.06+1!, 1.07+1!, 2.01+1*!, 2.02+1*!, 2.03+1!, 3.01+1!, 3.02+1!, 3.03+1!, 3.04+1!, 4.01+1!
, 4.02+1!, 4.03+1!, 4.04+1!
>> Y .05+1, 2.01+1, 2.02+1
Info |  Desc |  Directly Accessed By Routines |  Accessed By FileMan Db Calls |  Fields |  External References |  Global Variables Directly Accessed |  Local Variables  | All