GLOBAL PACKMAN MESSAGE API ICR (10071)

Name

Value

NUMBER

10071

IA #

10071

DATE CREATED

1995/02/19

CUSTODIAL PACKAGE

MAILMAN

CUSTODIAL ISC

San Francisco

USAGE

Supported

TYPE

Routine

DBIC APPROVAL STATUS

APPROVED

ROUTINE

XMPG

NAME

GLOBAL PACKMAN MESSAGE API

ORIGINAL NUMBER

10071

GENERAL DESCRIPTION

This routine contains the following API:

ENT^XMPG - Create and send a PackMan message with globals

STATUS

Active

XMPG

COMPONENT/ENTRY POINT

COMPONENT DESCRIPTION

VARIABLES

ENT

Create and send a PackMan message with any number of
local or global data arrays.  If no recipients are defined, the message will
be created, but it won't be sent anywhere.  Addressing restrictions are waived
(it's as if you set XMDF).  (To create and send a PackMan message with
routines in it, use ^XMD).

Usage: D ENT^XMPG

Inputs:
DUZ         Sender
XMSUB       Subject
XMY         Recipients
XMTEXT      A semi-colon separated list of open roots

Outputs:
XMZ         Message Number

Example:
K XMZ,XMMG ; It's a good idea to kill these or new them
S XMSUB="Demo",XMY(DUZ)="",XMTEXT="LOCAL(;^TMP($J,""A"","
D ENT^XMPG I '$D(XMZ) W *7,!,"*** Packman message NOT created."

Note:  Only the variables that are necessary for the entry point should exist.
If other XM namespaced variable exists, results may not be predictable.  If
XMTEXT does not point to valid packman data, the data may not be successfully
transferred in its entirety.

VARIABLES	TYPE	VARIABLES DESCRIPTION
DUZ	Input	The user's DUZ. The user's IEN in the NEW PERSON file (200).
XMDUZ	Used	(optional) The DUZ of the person from whom the message should appear to be. Default is DUZ.
XMSUB	Input	The subject of the message. Must be 3-65 characters.
XMTEXT	Input	A semi-colon (;) delimited string of the open roots of arrays and globals to be loaded into the PackMan message.
XMY	Used	(optional) Recipients to whom to send the PackMan message. XMY(addressee)="" XMY is killed upon successful completion of this API.
TMP("XMP",$J,	Used	(optional) If you wish to place any message text in the PackMan message to be read by any of the recipients, place it under ^TMP("XMP",$J), as follows: ^TMP("XMP",$J,1,0)="Hi! Here are the globals" ^TMP("XMP",$J,2,0)="for our project" etc. ^TMP("XMP",$J) is killed upon successful completion of this API.
DIFROM	Used	(optional) Specifically for FileMan or KIDS packages.
XMZ	Output	If the API is successful, message IEN in the MESSAGE file (3.9) of the Packman message which was created. If the API is not successful, it's unchanged or undefined. It's important, therefore, that XMZ be newed or killed before this API is called.
XMMG	Output	If the API is successful, it's unchanged or undefined. If the API is not successful, it contains an error message. It's important, therefore, that XMMG be newed or killed before this API is called.