STANDARD DATA DICTIONARY #3.6 -- BULLETIN FILE 6/27/25 PAGE 1
STORED IN ^XMB(3.6, (190 ENTRIES) SITE: WWW.BMIRWIN.COM UCI: VISTA,VISTA (VERSION 8.0)
DATA NAME GLOBAL DATA
ELEMENT TITLE LOCATION TYPE
-----------------------------------------------------------------------------------------------------------------------------------
Bulletins are 'Super' messages. Each Bulletin has a text and a subject just like a normal message. But embedded within either the
subject or the text can be variable fields that can be filled in with parameters. There is also a standard set of recipients in
the form of a Mail Group that is associated with the bulletin.
Bulletins are processed by MailMan either because of a special cross reference type of FileMan or because of a direct call in a
routine. The interface for the direct call is described in the documentation on programmer entry points. FileMan sets up code
that will issue a bulletin automatically when the special cross reference type is created. In either case the parameters that go
into the text and/or the subject make each bulletin unique.
DD ACCESS: #
WR ACCESS: #
DEL ACCESS: #
APPLICATION GROUP(S): XU, XM
POINTED TO BY: SERVER BULLETIN field (#220) of the OPTION File (#19)
CROSS
REFERENCED BY: NAME(B)
3.6,.01 NAME 0;1 FREE TEXT (Required)
A Unique name of bulletin, beginning with the package prefix
INPUT TRANSFORM: D CHKNAME^XQ5 K:$L(X)>30!(X["""")!(+X=X)!($L(X)<3)!'(X'?1P.E)!(X'?.ANP) X
LAST EDITED: JUL 07, 1988
HELP-PROMPT: NAME MUST BE 3-30 CHARACTERS, NOT NUMERIC OR STARTING WITH PUNCTUATION
DESCRIPTION: This field is the name of the bulletin, in the standard format of a two character package prefix,
followed by a descriptive name.
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
CROSS-REFERENCE: 3.6^B
1)= S ^XMB(3.6,"B",$E(X,1,30),DA)=""
2)= K ^XMB(3.6,"B",$E(X,1,30),DA)
3.6,2 SUBJECT 0;2 FREE TEXT (Required)
The subject of the message generated, as it will appear on the message
INPUT TRANSFORM: K:$L(X)>65!($L(X)<3) X
LAST EDITED: SEP 22, 1983
HELP-PROMPT: ANSWER MUST BE 3-65 CHARACTERS IN LENGTH
DESCRIPTION: This is the subject of the bulletin, as it will appear to the recipient. Note that it may contain
windows, just as in the "MESSAGE" field.
3.6,4 MAIL GROUP 2;0 POINTER Multiple #3.62
DESCRIPTION: This is a list of the mail groups to which this bulletin will be directed when triggered. If no
mail groups are defined, or they point to no users, then the bulletin is ignored.
3.62,.01 MAIL GROUP 0;1 POINTER TO MAIL GROUP FILE (#3.8) (Multiply asked)
The list of Mail Group(s) to which this bulletin will be sent
LAST EDITED: OCT 02, 1990
HELP-PROMPT: To which mail group should this bulletin be sent?
DESCRIPTION:
This is the name of a mail group to which this bulletin will be directed when triggered.
CROSS-REFERENCE: 3.62^B
1)= S ^XMB(3.6,DA(1),2,"B",$E(X,1,30),DA)=""
2)= K ^XMB(3.6,DA(1),2,"B",$E(X,1,30),DA)
3.6,5 RETENTION DAYS 0;3 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>365)!(X<0)!(X?.E1"."1N.N) X
LAST EDITED: MAR 25, 2002
HELP-PROMPT: Type a Number between 0 and 365, 0 Decimal Digits
DESCRIPTION: After this number of days, if the bulletin hasn't already been purged, it will be purged by the
XMAUTOPURGE option. If zero or null, the bulletin will not have a purge date, and will not be
purged by XMAUTOPURGE.
3.6,6 DESCRIPTION 3;0 WORD-PROCESSING #3.63
DESCRIPTION: This field is a description of the bulletin, for documentation purposes. It is not used by MailMan
for any automatic processing.
A short description of the purpose of this bulletin, for documentation purposes
LAST EDITED: OCT 06, 1983
HELP-PROMPT: What's the purpose of this bulletin?
DESCRIPTION:
This field describes the bulletin.
3.6,10 MESSAGE 1;0 WORD-PROCESSING #3.61
DESCRIPTION: This holds the "canned" text of the bulletin which will be sent when the bulletin is fired.
Variable text may be stored in parameters at the time of firing, then inserted in the message text.
Parameter windows are defined by putting them within vertical bars, with the parameter number
inside. For example, "Appointment for |1| on |2| has been cancelled." with parameter 1 set to
"Jones", and parameter 2 set to "Monday" would generate a bulletin of "Appointment for Jones on
Monday has been cancelled."
Parameters may be set with fileman (in the Bulletin cross reference) or by programmers from within
programs.
3.6,11 PARAMETER 4;0 Multiple #3.64 (Add New Entry without Asking)
DESCRIPTION:
This defines the parameters, which will be used to set information into the bulletin.
IDENTIFIED BY:
"X": W:$D(^(1,1))#2 " ",^(1),"..."
3.64,.01 PARAMETER 0;1 NUMBER (Multiply asked)
INPUT TRANSFORM: S DINUM=X K:+X'=X!(X>100)!(X<0)!(X?.E1"."1N.N) X,DINUM
LAST EDITED: OCT 12, 1983
HELP-PROMPT: TYPE A WHOLE NUMBER BETWEEN 0 AND 100
DESCRIPTION:
This defines a parameter which will be used to set information into the bulletin.
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
3.64,1 DESCRIPTION 1;0 WORD-PROCESSING #3.65
DESCRIPTION: This is a description of the parameter, to be inserted into the bulletin. It is purely for
documentation purposes.
LAST EDITED: OCT 12, 1983
DESCRIPTION: This is a description of the parameter to be inserted into the bulletin. It is purely for
documentation purposes.
3.6,12 PRIORITY? 0;4 SET
'0' FOR NO;
'1' FOR YES;
LAST EDITED: JUN 11, 1997
HELP-PROMPT: Should this bulletin be a priority message?
DESCRIPTION: If you want this bulletin to appear to the recipients as a priority message, enter 'yes'; if not,
enter 'no'.
FILES POINTED TO FIELDS
MAIL GROUP (#3.8) MAIL GROUP:MAIL GROUP (#.01)
INPUT TEMPLATE(S):
PRINT TEMPLATE(S):
SORT TEMPLATE(S):
FORM(S)/BLOCK(S):