Customize the contents of a message template

You can adapt the contents of a message template in ARIS Risk & Compliance Manager. The texts contain functions that can be used to insert variable text into the message, for example, the name of the relevant user with $user.getName(). The functions are preceded by a $ and must not be changed.

Procedure

  1. Click ARIS Risk & Compliance Manager Administration Administration. The General menu item is displayed initially.
  2. Click Basic settings under System management or click Environments under Environment management, depending on which message template you want to edit.
  3. If you selected Environments, click the relevant environment ID and then select Notification.
  4. If you selected Basic settings, select Notification. The list is displayed.
  5. Open the message template you want to change.
  6. Change the subject or text.
  7. Click the relevant Notification type to specify whether notifications are to be sent by e-mail and/or to the internal ARIS Risk & Compliance Manager mailbox.
  8. Click Save Save.

Options or text for the automatic notification are changed. As long as you do not restore the message template to the default using the user interface, the content from the database is used. Another method of modifying a message template is similar to the method of adding a new message template (see Add a new message template). The only difference is that you adapt the property value.

Remark

If a message template requires values that can only be determined dynamically during runtime, they are incorporated as objects and variables. The difference between these two both options is that an object provides the methods for accessing values, while a variable has a given value.

By default, the object responsible for the form flow is always available. You can access all attributes defined for these object types including Inheritance using the corresponding method.

The usage of objects in a message template must comply with the following conventions:

  • For an object or a variable to be accessible, the prefix $ must always be added.
  • The object name always corresponds to the defined attribute ID of the <objectType> element in lower-case letters.
  • The method name always consists of the prefix get and the attribute ID of the <attrType> element. Note that get must always be followed by an upper-case letter. Furthermore, underscores in the ID are identified via a filter and replaced with the upper-case letter of the subsequent word.

Example

Object type Testdefinition with defined ID TESTDEFINITION and attribute owner_group

Access to this attribute in the message template: $testdefinition.getOwnerGroup()

The following additional objects and variables are available by default:

  • $user – Object providing recipient information
  • $client – Object providing environment information
  • $serverConnection – Variable providing a link to the server

If more objects or variables are required, they can only be provided by Java code implementation. User-defined implementations are indicated by message templates that already use additional objects and variables.

Documents

objectTypes.xml, objectTypes.xsd

Example

ModifyMessageTemplate_AddNewMessageTemplate

\WEB-INF\config\custom\properties\application\custom.properties: Add contents to new message template