Get Macro Message Defaults - OMGMMD

Get Macro Message Defaults (OMGMMD)

Required Parameter Group:

1	Macro Number	Input	Packed(3,0)
2	Message Schedule	Output	Char(1)
3	Allow Schedule Override	Output	Char(1)
4	Message Reply-To Designator	Output	Char(10)
5	Allow Reply-To Override	Output	Char(1)
6	Return Receipt	Output	Char(1)
7	Allow Return Receipt Override	Output	Char(1)
8	Message Priority	Output	Char(1)
9	Allow Message Priority Override	Output	Char(1)
10	Return Status	Output	Char(1)

API Overview:
This is a customizable site-specific program whose source resides in the deliverable source library, OMNIDLVSRC. All site-specific programs should be compiled into the site library, OMNISITE.

The Get Macro Message Defaults API (OMGMMD) was developed in order to provide a mechanism for the customer to establish account-wide settings that must be used for certain forward macro messages created from the QTRACS User Interface.

Specifically, this program is called by the Create Message UI during forward message creation when a user selects a macro template number. Its purpose is to allow the customer to provide and/or enforce certain attributes that must be used when a user sends a particular forward message. Any defaults provided by this program are enforced for all users. If only some attributes are specified for the forward message but others are not, the user's defaults will be used for the unspecified attributes.

Required Parameter Group Details:
(1) Macro Number
INPUT; PACKED(3,0)
This parameter contains the forward macro number of the message being created at the UI.

(2) Message Schedule
OUTPUT; CHAR(1)
This parameter returns the default value for the message schedule field. Valid values are:

0	Immediate
1	Batch*

*Note: Batch can not be used with a Message Priority of '9', an error message will result.

(3) Allow Schedule Override
OUTPUT; CHAR(1)
This parameter indicates whether the user is permitted to change the Message Schedule parameter to another value. Valid values are:

0	No
1	Yes

(4) Message Reply-To Designator
OUTPUT; CHAR(10)
This parameter returns the default value for the reply-to-designator field. Valid values are:

Entity Name	Replies routed to this user or address list
*PERSONAL	Replies routed to sender
*DISPATCH	Replies routed to coverage

(5) Allow Reply-To Override
OUTPUT; CHAR(1)
This parameter indicates whether the user is permitted to change the Message Reply-To Designator parameter to another value. Valid values are:

0	No
1	Yes

(6) Return Receipt
OUTPUT; CHAR(1)
This parameter returns the default value for the return receipt field. Valid values are:

0	Off
1	On

(7) Allow Return Receipt Override
OUTPUT; CHAR(1)
This parameter indicates whether the user is permitted to change the Return Receipt parameter to another value. Valid values are:

0	No
1	Yes

(8) Message Priority
OUTPUT; CHAR(1)
This parameter returns the default value for the message priority field. Valid values are:

0	Normal
1	Important
2	Sleepy
3	Sleepy+
9	Emergency

(9) Allow Message Priority Override
OUTPUT; CHAR(1)
This parameter indicates whether the user is permitted to change the Message Priority parameter to another value. Valid values are:

0	No
1	Yes

(10) Return Status
OUTPUT; CHAR(1)
Status value returned to the Create Message UI.

0	Success, use the returned values
1	Failure, ignore the returned values

Effect
This program will not normally exist at a customer site because it is not delivered as an object. It will only exist if the customer decides to make use of this feature. If the program does not exist, or the program contains no logic for a given macro number, then the Create Message UI will function as it always has.
Alternately, if the customer decides to make use of this program, it should be modified to suit and compiled into the site-specific library. The Create Message UI will automatically detect it and call it each time a forward message is created. The Create Message UI enforces any defaults returned by this API.