XMVSM APIs ICR (7549)

Name

Value

NUMBER

7549

IA #

7549

DATE CREATED

2025/04/28

CUSTODIAL PACKAGE

MAILMAN

USAGE

Private

TYPE

Routine

DBIC APPROVAL STATUS

APPROVED

ROUTINE

XMVSM

NAME

XMVSM APIs

GENERAL DESCRIPTION

The purpose of this Routine is to provide read-only
APIs returning MailMan 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

XMVSM

COMPONENT/ENTRY POINT

COMPONENT DESCRIPTION

VARIABLES

$$XMLIST(XMARR)

Returns the number of mail messages queued on each
mail domain, total number of messages queued and the total number of domains
with queued messages.

Usage: D XMLIST^XMVSM(.XMARR)

VARIABLES

TYPE

VARIABLES DESCRIPTION

XMARR

Both

The name of the output array, passed by reference, to
contain the message counts.

XMARR("DOMAINS",DOMAIN)=Message Count ^ Device XMARR("TMQUED")=Total messages
queed XMARR("TOTDOMS")=Total domains with queued messages

SUBSCRIBING PACKAGE

CAPACITY MANAGEMENT

DATE ACTIVATED

2025/04/29