Print Page as PDF
XUVSM APIs ICR (7550)

XUVSM APIs    ICR (7550)

Name Value
NUMBER 7550
IA # 7550
DATE CREATED 2025/04/28
CUSTODIAL PACKAGE KERNEL
USAGE Private
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE XUVSM
NAME XUVSM APIs
GENERAL DESCRIPTION
The purpose of this Routine is to provide read-only
APIs returning KERNEL operational states.

The VistA System Monitor (VSM) will use this data to display this operational
state data in a real-time VistA Operations Dashboard. VSM functionality
consuming these APIs will initially be deployed via patch KMP*4.0*5.
STATUS Active
KEYWORDS
  • VistA System Monitor
  • VSM
DURATION Till Otherwise Agreed
ID XUVSM
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
$$RUNSTATUS()
Returns the run status of TaskMan.

Usage: S Y=$$RUNSTATUS^XUVSM()
VARIABLES TYPE VARIABLES DESCRIPTION
Y Output
This API returns a "^" delimited string.

Piece 1: Text Status. (ex. "Current") Piece 2: Number of seconds behind Piece
3: Current Timestamp Piece 4: Run Node Timestamp
$$STATLIST(XUARR)
Returns the TaskMan status list.

Usage: D $$RUNSTATUS^XUVSM(.XUARR)
VARIABLES TYPE VARIABLES DESCRIPTION
XUARR Both
A variable passed by reference to contain the output
data.

XUARR("LIST",D0,"EXECUTE")=Execution Status XUARR("LIST",D0,"JOBNUM")=Job
Number XUARR("LIST",D0,"NODE")=Node XUARR("LIST",D0,"STATUS")=Status
XUARR("LIST",D0,"TIME")=Current Time XUARR("LIST",D0,"STATMESS")=Text message
if available
$$SCHLIST()
Returns task status count by category.

Usage: S Y=$$SCHLIST^XUVSM()
VARIABLES TYPE VARIABLES DESCRIPTION
Y Output
Returns a "^" delimited string.

Piece 1: Number of tasks scheduled Piece 2: Number of tasks late Piece 3:
Number of seconds late for nearest task
$$IOLIST(XUARR)
Returns the status on tasks waiting for IO.

Usage: D $$IOLIST^XUVSM(.XUARR)
VARIABLES TYPE VARIABLES DESCRIPTION
XUARR Both
XUARR is a variable passed by reference to hold the
return values.

XUARR("LASTDEV") XUARR("LASTSCAN") XUARR("TTSKWAIT")
$$JOBSWAIT()
Returns the number of tasks waiting to execute.

Usage: S Y=$$JOBSWAIT^XUVSM()
VARIABLES TYPE VARIABLES DESCRIPTION
Y Output
Y = The number of tasks waiting to execute.
$$TASKSRUN()
Returns the number of tasks currently running.

Usage: S Y=$$TASKSRUN^XUVSM()
VARIABLES TYPE VARIABLES DESCRIPTION
Y Output
Y = the number of tasks currently running.
$$SMLIST(XUARR)
Returns the status on TaskMan submanagers.

Usage: D $$SMLIST^XUVSM(.XUARR)
VARIABLES TYPE VARIABLES DESCRIPTION
XUARR Both
XUARR is a variable passed by reference to hold the
output values.

XUARR("SUBMWAIT")= Wait Status   (1:told to wait or 0:OK)
XUARR("LIST","D0,"NODE")=Node XUARR("LIST",D0,"COUNT")=Task Count
XUARR("LIST",D0,"STATUS")=Current Status  (Stop, Wait or run)
XUARR("LIST",D0,"NOSTART")=Start Flag (1="Submanagers Not Starting", 0="OK")
$$INSTALL(.XUIN,XUSDAT,XUEDAT)
Returns the status on patch installations.

Usage: D $$INSTALL^XUVSM(.XUIN,XUSDAT,XUEDAT)
VARIABLES TYPE VARIABLES DESCRIPTION
XUIN Both
A variable passed by reference to hold the output
values.

XUIN(IDATE,PATNUM)="" where
IDATE =  Patch Install Date
PATNUM = Patch Number
XUSDAT Input
Start date for search in YYY-MM-DD format.
XUEDAT Input
End date for search in YYY-MM-DD format.
$$FUT(.ZTCHECK)
Returns the status of specified options expected to
be tasked in the future.

Usage: D $$FUT^XUVSM(.ZTCHECK)
VARIABLES TYPE VARIABLES DESCRIPTION
ZTCHECK Both
ZTCHECK is an array passed by reference in the form
of:
ZTCHECK("option to be checked")="Not Scheduled"

If an option in the input array is found to be scheduled in the future the
value of "Not Scheduled" will be replace by a "^" string depicting the date
and time in the future for which the option is tasked.
SUBSCRIBING PACKAGE CAPACITY MANAGEMENT
DATE ACTIVATED 2025/04/29