Changing the Texts of Notification E-Mails

Prerequisites

This procedure requires you to stop the AS Java, so you should plan for the required downtime while the AS Java restarts.

Context

The user management engine (UME) ships with default texts for notification e-mails. These texts are stored in a Java archive (JAR) file on the SAP NetWeaver Application Server (AS) Java. You can modify the default texts and store them in the configuration store of the AS Java. The modified texts stored in the configuration store have priority over the texts in the JAR file and are not overwritten during an upgrade.

The notification texts are defined in packaged files. There are a number of files delivered with the UME. Each file includes the e-mail notification texts for a single Java locale. User management also provides a range of placeholder variables that you can use in the text.

Procedure

Create a file for the language you require, and enter the texts that you want to use for notification e-mails.

Recommendation

We recommend that you copy an existing file and modify it as required.

To modify an existing file, proceed as follows:

On the file server, navigate to the following location:

<AS_Java_Installation> \j2ee\cluster\bin\ext\com.sap.security.core.sda\
From the file sap.com~tc~sec~ume~core~impl.jar, extract the file com.sap.security.core.jar.
From the file sap.com~tc~sec~ume~core~impl.jar, extract the file notificationTexts_ <Java_locale> .properties.

The Java locales consist of the ISO 639-1 language code and an optional ISO 3166 country code separated by an underscore (_).

Example

There is a separate file for each language. German texts are defined in notificationTexts_de.properties. Texts for Hong Kong Chinese are defined in notificationTexts_zh_HK.properties. To modify the e-mail message in several languages, you must modify all the corresponding files.

Create a copy of the file and modify the copy as required.

For line breaks, use \n control sequence.

The following placeholders are defined and can be used to pull relevant variables from the user data.

Placeholder	Description
`{0}`	Display name of the sender.
`{1}`	Salutation of the sender.
`{2}`	First name of the sender.
`{3}`	Last name of the sender.
`{4}`	Display name of the receiver.
`{5}`	Salutation of the receiver.
`{6}`	First name of the receiver.
`{7}`	Last name of the receiver.
`{8}`	Password of the receiver. Note The system replaces the placeholder with the password: When users register themselves and the system generates the user passwords automatically When users reset their own passwords with the logon help When the user administrator changes or resets the user's password When the user administrator creates a new user Caution The system sends the password in plain text. Users must change their passwords at the first opportunity.
`{9}`	Free text. This is the text that the administrator or user can add in the text box, for example when locking a user. Do not remove the free text placeholder.

Save the file with the name com.sap.security.core.util.notification.notificationTexts_ <Java_locale> .properties.
Note

When determining which file to use for the notification texts, the UME uses the following criteria:
- If the Java locale of the user is specified, the UME tries to match the Java locale in the user profile with the Java locale in the filename. The UME checks for that exact Java locale, then checks for the less specific versions of the locale until it finds a match.
  
  Example
  
  Donna Moore has specified a Java locale en_US_Bronx in her user profile during self-registration. The UME first checks for a file with en_US_Bronx. If it cannot find one, it checks for a file with en_US. If it cannot find one, it checks for a file with en. If it still cannot find one it uses the default notification texts.
- If the Java locale of the user is not specified, the user receives the text from the default e-mail notification text file.

Upload the file to the AS Java as follows:
1. Shut down all cluster elements.
2. Start the config tool.
3. Choose the pushbutton.
4. In the Display Configuration tab, choose cluster_config system custom_global cfg services com.sap.security.core.ume.service persistent.
5. Choose the pushbutton.
6. Select the persistent node and choose the pushbutton.
  
  A dialog box appears.
7. Choose File entry .
8. Upload the file you created.
  
  The text of your file appears in the text field.
9. Create the file and then close the window.
  
  A new entry appears under persistent with the name com.sap.security.core.util.notification.notificationTexts_ <Java_locale> .properties.
10. Restart all cluster elements.

Results

The modified texts appear in the notification e-mails.

Next Steps

Configuring the List of Available Languages