Print Page as PDF
HLVSM APIs ICR (7551)

HLVSM APIs    ICR (7551)

Name Value
NUMBER 7551
IA # 7551
DATE CREATED 2025/04/28
CUSTODIAL PACKAGE HEALTH LEVEL SEVEN
USAGE Private
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE HLVSM
NAME HLVSM APIs
GENERAL DESCRIPTION
The purpose of this routine is to provide read-only
APIs returning HL7 operational status.

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 HLVSM
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
$$GETFILERS(HLDIR,HLARR)
Returns the number of IN/OUT filers and the status of
each.

Usage: S Y=$$GETFILERS^HLVSM(HLDIR,HLARR)
VARIABLES TYPE VARIABLES DESCRIPTION
HLDIR Input
"IN" to request status on incoming filers.  "OUT" to
request status on outgoing filers.
HLARR Both
The name of the output array to contain the status of
each filer. Passed by value.

Returns an array, subscripted by job number, with a "^" string for each entry.

HLARR(JOBNUMBER)=STRING where:

Piece 1: Job Number Piece 2: Last Run Date Piece 3: Stop Flag Piece 4: Request
Timestamp Piece 5: Error (if any)
$$FILERCFG()
Returns the number of filers configured.

Usage: S Y=$$FILERCFG^HLVSM()
VARIABLES TYPE VARIABLES DESCRIPTION
Y Output
Contains the number of filers configured.
$$LMSTAT()
Returns the link manager status.

sS Y=$$LMSTAT^HLVSM()
VARIABLES TYPE VARIABLES DESCRIPTION
Y Output
Y will contain the status of the Link Manager.

1: Running 0: Not Running
$$CHKSTOP()
Returns the HLO System Status.

Usage: S Y=$$CHKSTOP^HLVSM()
VARIABLES TYPE VARIABLES DESCRIPTION
Y Output
Y contains the HLO System Status.

1: Stopped 0: Running
$$PROCMAN()
Returns the HLO Process Manager Status

Usage: S Y=$$PROCMAN^HLVSM()
VARIABLES TYPE VARIABLES DESCRIPTION
Y Output
Y contains the HLO Process Manager status.

1: Running 0: Stopped
$$MPOQ(.HLOQARR)
Returns the number of messages pending on the OUT
queue with a list of message metadata.

Usage: S Y=$$MPOQ^HLVSM(.HLOQARR)
VARIABLES TYPE VARIABLES DESCRIPTION
Y Output
To messages pending on the OUT queue.
HLOQARR Both
A variable passed by reference to contain the output
data.

HLOQARR("OUT")=Total messages queued HLOQARR("OUT",Link,Queue)=Count per
Link/queue
$$MPSQ(.HLSQARR)
Returns the number of messages pending on the
SEQUENCE queue with a list of message metadata.

Usage: S Y=$$MPSQ^HLVSM(.HLSQARR)
VARIABLES TYPE VARIABLES DESCRIPTION
XUSQARR Both
A variable passed by reference to hold the output
values.

HLSQARR("OUT")=Total number of messages queued.
HLSQARR("OUT",Link,Queue)=Number of messages per link/queue.
$$MPAQ(.HLAQARR)
Returns the number of messages pending on the
APPLICATION queue with a list of message metadata.

Usage: S Y=$$MPAQ^HLVSM(.HLAQARR)
VARIABLES TYPE
HLAQARR Both
$$ADD(HLTYPE)
Returns the number of messages sent, received, in
error out, and in error in per requested type.
VARIABLES TYPE VARIABLES DESCRIPTION
HLTYPE Input
Determines which type of message data will be
returned. HLTYPE should be one of the following:

OUT: returns messages sent
IN: returns messages received
EOUT: returns outbound message errors
EIN: returns inbound message errors
$$CLPROC(HLDIR)
Returns the number of IN or OUT client link
processes.

Usage: S Y=$$CLPROC^HLVSM(HLDIR)
VARIABLES TYPE VARIABLES DESCRIPTION
HLDIR Input
"OUTOING CLIENT LINK":  Returns OUT processes
"INCOMING QUEUES": Returns IN processes
Y Output
Contains the number of processes returned.
$$FILE777()
Returns the File 777 record count from ^HLTMP.

Usage: S Y=$$FILE777^HLVSM()
VARIABLES TYPE VARIABLES DESCRIPTION
Y Output
Contains the File 777 Record Count from ^HLTMP.
$$FILE778()
Contains the File 778 Record Count from ^HLTMP.

Usage: S Y=$$FILE778^HLVSM()
VARIABLES TYPE VARIABLES DESCRIPTION
Y Output
Contains the File 778 Record Count from ^HLTMP.
$$SLM()
Returns the currency of the HLO Link Manager.

Usage: S Y=$$SLM^HLVSM()
VARIABLES TYPE VARIABLES DESCRIPTION
Y Output
Contains the currency of the HLO Link Manager.
$$LSTAT()
Returns the HLO Link Manager status.

Usage: S Y=$$LSTAT^HLVSM()
VARIABLES TYPE VARIABLES DESCRIPTION
Y Output
Contains the HLO Link Manager status.

1: Running 0: Stopped
$$DLINKS()
Returns a list of failing logical links up to 60
characters in total length.

Usage: S Y=$$DLINKS^HLVSM()
VARIABLES TYPE VARIABLES DESCRIPTION
Y Output
A list of failing links.
$$STQUES(HLDIR)
Returns the number of stopped In or OUT queues.

Usage: S Y=$$STQUES^HLVSM(HLDIR)
VARIABLES TYPE VARIABLES DESCRIPTION
HLDIR Input
IN: incoming queues OUT: outgoing queues
Y Output
The number of stopped queues.
GETVIEWS(.HLVARR)
Returns a list of Logical Link Views.

Usage: D GETVIEWS^HLVSM(.HLVARR)
VARIABLES TYPE VARIABLES DESCRIPTION
HLVARR Both
A variable passed by reference to hold output values.

HLVARR(VIEW, SORT ORDER, LINNK)=""
SUBSCRIBING PACKAGE CAPACITY MANAGEMENT
DATE ACTIVATED 2025/04/29