STANDARD DATA DICTIONARY #8969 -- VSM CONFIGURATION FILE 3/24/25 PAGE 1
STORED IN ^KMPV(8969, (7 ENTRIES) SITE: WWW.BMIRWIN.COM UCI: VISTA,VISTA (VERSION 4.0)
DATA NAME GLOBAL DATA
ELEMENT TITLE LOCATION TYPE
-----------------------------------------------------------------------------------------------------------------------------------
This file contains current configuration data related to the daily operation of each monitor deployed.
CROSS
REFERENCED BY: MONITOR KEY(B)
LAST MODIFIED: DEC 18,2020@15:22:31
8969,.01 MONITOR KEY 0;1 FREE TEXT (Required)
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)
8969,.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.
8969,.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.
8969,.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.
8969,.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.
8969,1.01 DAYS TO KEEP DATA 1;1 NUMBER (Required)
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.
8969,1.02 COLLECTION INTERVAL 1;2 NUMBER (Required)
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.
8969,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.
8969,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").
8969,1.05 TASKMAN SCHEDULE FREQUENCY 1;5 FREE TEXT
INPUT TRANSFORM: K:$L(X)>10!($L(X)<1) X
LAST EDITED: DEC 02, 2014
HELP-PROMPT: Answer must be 1-10 characters in length.
DESCRIPTION:
The value used to automatically reschedule the TaskMan tasks. (ex. 1D or 1W)
8969,1.06 TASKMAN SCHEDULE START 1;6 FREE TEXT
INPUT TRANSFORM: K:$L(X)>20!($L(X)<1) X
LAST EDITED: DEC 02, 2014
HELP-PROMPT: Answer must be 1-20 characters in length.
DESCRIPTION:
The time each monitor's TaskMan task should be scheduled. (ex. T+1@0001)
8969,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.
8969,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.
8969,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).
8969,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.
8969,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.
8969,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.
8969,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.
8969,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.
8969,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.
8969,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.
8969,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.
8969,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.
8969,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.
8969,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.
INPUT TEMPLATE(S):
PRINT TEMPLATE(S):
SORT TEMPLATE(S):
FORM(S)/BLOCK(S):
KMPV EDIT CONFIGURATION OCT 14, 2014@14:28 USER #0
KMPV EDIT CFG DD #8969
KMPV EDIT TITLE DD #8969
KMPV VIEW CONFIGURATION OCT 15, 2014@08:48 USER #0
KMPV VIEW CFG DD #8969
KMPV VIEW TITLE DD #8969