Show TOC

Enabling E-Mail Notifications for CBS Build SpacesLocate this document in the navigation structure

Use

With this procedure you enable e-mail notifications for concrete build spaces in the Component Build Service (CBS).

Procedure

1. (One time only) Configure the user access

Note that you can review the configured e-mail notifications in the e-mail notification service even with a user that has no administrative roles. However, to be able to change the e-mail notifications, you have to be Application Server Java (AS Java) or SAP NetWeaver Development Infrastructure (NWDI) administrator.

To enable the e-mail notification service, you have to configure a user to access the CBS. For that purpose, you create a dedicated user to use for this connectivity. A connectivity user must have permissions for read access to the CBS, and administrator's rights on the AS Java. Assign the user to the SAP_DI_DEVELOPER role and to the NWDI.Administrators group. The connectivity user must have the following characteristics:

  • To be able to read the buildspace list from CBS. For this purpose, the SAP_DI_ADMINISTRATOR role is required.

  • To be able to read folders below /ws in DTR. For this purpose, the NWDI.Administrators group is required.

  • To be able to get information from the Application Server Java (AS Java), such as the host name and HTTP(S) ports that are required to put into the e-mails. For this purpose, the SAP_JAVA_NWADMIN_LOCAL_READONLY role is required.

For more information about configuring the user in the SAP NetWeaver Administrator, see Identity Management and Assigning Principals to Roles or Groups .

Once you have set up the user, you have to add it in the e-mail notification service. To do that:

  1. In your browser, go to http://<host>:<port>/devinf and log on as an administrator. Choose the E-Mail Notification Service link.

  2. Open the Global Notification Settings tab page. Choose the Edit pushbutton.

  3. Enter the name of the connectivity user in the NWDI Access User field. Enter the user's password in the NWDI Access Password field. Repeat again the password in the Access Password Confirmation field.

  4. Save the changes.

2. (One time only) Enable e-mail notifications for CBS build spaces

You do this step only once, to initially enable the e-mail notifications. To do that:

  1. In the SAP NetWeaver Administrator tool set the property notificationEnabled to true for CBS.

    Note

    You need administrators permissions to change this value.

    To set the property value in the SAP NetWeaver Administrator:

    1. In your browser, go to http://<host>:<port>/nwa .

    2. Open the tab page Start of the navigation path Configuration Next navigation step Infrastructure Next navigation step Java System Properties End of the navigation path. In the page that appears, choose the Services tab page.

    3. Select the Component Build Service service from the list of services.

    4. On the Properties tab page, select the property notificationEnanbled .

    5. Choose the Modify pushbutton and in the dialog that appears, set the value of this property to true .

    6. Save your settings.

  2. In your browser, go to http://<host>:<port>/devinf . Choose the E-Mail Notification Service link.

  3. Choose the Global Notification Settings tab page. Choose the Edit pushbutton.

    1. Set the value of the property enabled to true .

    2. Set the value of the property simulation to false .

  4. Configure the SMTP host name to be used for the e-mail notifications, for example mail.sap.corp . To do that, set the host name as the value of the property SMTPHost .

  5. Choose the Save pushbutton.

3. (One time only) Define how often to check for notification events

With this step you define how often the e-mail notification service will check for events that could trigger e-mail notifications. This is a mandatory step.

  1. Open the SAP NetWeaver Administrator tool.

    In your browser, go to http://<host>:<port>/nwa .

  2. Open the tab page Start of the navigation path Operations Next navigation step Jobs End of the navigation path. Choose the Java Scheduler link.

  3. In the Java Scheduler, open the Tasks tab page and choose the Add pushbutton.

  4. In the wizard that appears, find the NWDINotifyJob job. Choose Next .

  5. Specify NWDINotifyTask as the display name for the task. Choose Next . In the Set Properties steps, choose Next again.

  6. In the Set Execution Time step, on the Reccuring tab page, specify the end date when the e-mail notifications will be automatically stopped. In the Period fields, we recommend that you define 60 seconds as the time interval for checking for new events.

  7. Choose the Add pushbutton. Complete the wizard.

4. Create an e-mail template for the notification

You now have to create a template to be used for the sent e-mails. The template you want to use has to be created in HTML language. Then you can upload this e-mail notification template in the e-mail notification service. Note that you can create and configure several different notification templates to be used when different events occur. However, you cannot change the list of participants of these e-mails - they are always sent to the same list of e-mail addresses.

You can create your own e-mail templates to use upon e-mail notification events. The file that you want to use as the template must be in HTML format:

  1. Create a file to be used as the template. Store it on your system. For more information about creating such a template, see Configuring E-Mail Notification Templates .

  2. In your browser, go to http://<host>:<port>/devinf . Choose the E-Mail Notification Service link.

  3. On the HTML Templates tab page, browse to the location of the template file, then choose the Upload New Template pushbutton.

    The HTML template is uploaded in the list of templates. You can now use it when creating a new e-mail configuration or if you edit an existing one.

5. Configuring e-mail notifications for CBS buildspaces

  1. In your browser, go to http://<host>:<port>/devinf . Choose the E-Mail Notification Service link. Open the CBS Notification Settings tab page.

  2. Choose the Edit pushbutton.

  3. In the dialog that appears, specify the e-mail addresses of the receivers of the e-mail. To add more than one e-mail address, use a semi-colon (;) as the separator.

    Note that each address can be either a user ID from the identity management system (in which case, the e-mail address is retrieved from the identity management system), or a full e-mail address (identified by the at (@) sign).

  4. Specify the event upon which the e-mail notification should be triggered using the Plugin dropdown menu.

  5. Specify which HTML template should be used for the e-mails from the Template dropdown menu.

  6. Choose Add Selected Plugin .

    Note

    If you want to add more plug-ins, repeat steps 4, 5 and 6.

  7. Choose the Save Configuration pushbutton.