Skip to main content

Adding macros to messages

You can use M4macros that expand to text strings, in the language of the user, in notification messages. The macros can include HTML code to enhance the display of message content. The M4 system and requirements are detailed in the About the user interface .

The psntfsvc.m4 file in <Program Files path>\Bravura Security\Bravura Security Fabric\<instance>\ design\ src\z\ includes the following pre-defined macros:

Macro tag name

English text

EXPIRY_NONCOMP_MSG

Your password will expire in [%DAYS%] days.

EXPIRY_THANKS_MSG

Thank-you for changing your password.

EXPIRY_ACTION_MSG

You have exceeded the maximum number of reminders for this notification, no further reminders will be sent.

QAREG_NONCOMP_MSG

You have not completed your question & answer registration.

QAREG_THANKS_MSG

Thank-you for completing your question & answer registration.

QAREG_ACTION_MSG

You have exceeded the maximum number of reminders for this notification, no further reminders will be sent.

To use M4 macros, type the corresponding tag, beginning with !!!, in the relevant field in the Configure notification plugins pages; for example:

!!!EXPIRY_NONCOMP_MSG

After you click Update, the Displayed value of the M4 macro is shown as it appears in the message sent to users. You can use this to verify that you have entered the correct macro without triggering a notification message. For example, the tag shown in the example above has the following Displayed value:

Your password will expire in [%DAYS%] days.

To learn how to:

  • Add HTML code to enhance the display of the message content, see Change the layout .

  • Modify the text defined by the m4 macros, see Altering text .

    The message subject line for batch notifications can contain macros that expand to text, but you cannot include HTML code in the subject.

Adding custom tags

To add customized messages to notification plugin message fields:

  1. Create psntfsvc.m4 in <instance>\design\custom\ , if it does not already exist.

  2. Add lines to the custom file in the following format:

    !!!<MESSAGE_TAG>
<text>

    where <text> can include HTML code and M4 macros.

    For example:

    !!!SIMPLE_MESSAGE_TAG
Have a <strong>good</strong> day.
!!!TRANSLATABLE_MESSAGE
CUSTOM_MACRO_1
CUSTOM_MACRO_2
CUSTOM_MACRO_3

  3. To define text in multiple languages, create the < lang > - < locale > -language.kvg file for each supported language in <DESIGN>\custom\ if it does not already exist.

  4. Edit the macro definitions as required, in the format:

    "CUSTOM_MACRO_1" "" = { 
  "text" = "This is the first line of the message" 
} 
"CUSTOM_MACRO_2" "" = { 
  "text" = "... the second" 
} 
"CUSTOM_MACRO_3" "" = { 
  "text" = "...and the third.<br>Signed, your company" 
}

  5. In the relevant field in the Manage the system (PSA) module Configure notification plugins pages, type the corresponding tag beginning with !!! from psntfsvc.m4; for example, in Message to display to a non-compliant user for Set USERSTAT tag, type:

    !!!TRANSLATABLE_MESSAGE

  6. Recompile and install your skin (*.z) files by running make.bat in the design directory.

See also

See the Altering text for more information.

In this section: