MESSAGE
Generates user-defined error messages and conditions during EngageOne™ Enrichment processing. You can use this function to halt processing based on the value of a field. For example, if you define a field called %%ACCOUNT_NUM and you want to halt processing if the account number is null, you could specify the following in your rule file:
if %%ACCOUNT_NUM = "" then
message(1, S, "Account number is too large")
endif
This would generate a severe message (as indicated by the “S”) which would halt processing.
Syntax
MESSAGE(msg#,action,text,[include,exitrc])
Arguments
Argument | Description | Default | |
---|---|---|---|
msg# | A numeric value for the user-defined message (up to 10 characters in the range -2147483648 to 2147483647). | None | |
action | I(information), W (warning), or S (severe). Note: If you set action to S, EngageOne™ Enrichment processing will stop when the message occurs. |
None | |
text | Up to 32,767 characters of the message text. | None | |
include | One of the following to indicate whether to include the message in the report (ignoring the <MESSAGELEVEL> setting): | Y | |
Y | Always include the message in the report no matter how <MESSAGELEVEL> is set. | Y | |
N | Only include the message in the report based on the <MESSAGELEVEL> setting. | Y | |
exitrc | The return code for EngageOne™ Enrichment to exit with. exitrc applies only to action s (severe messages) that will result in an immediate exit from EngageOne™ Enrichment. The maximum value for exitrc is 256 on UNIX, Linux, and Windows and 2000 on mainframe systems. | 8 |
Results
Result | Description |
---|---|
Return | A null string (''). |
%%RC | Always 0. (The return code from the function call) |
%%RM | A null string (''). |
%%RV | Always 0. |
Examples
Function Call | Return | %%RC |
---|---|---|
MESSAGE(10000, S, 'Too many errors') Adds this message to the EngageOne™ Enrichment report with a %%RC of 8. This message indicates that EngageOne™ Enrichment’s final processing return code is 8. |
'' | 0 |