Implementation Guide for Oracle Self-Service E-Billing > Using and Customizing Email Notifications >

Configuring Messaging Properties


You can configure several optional properties that control email and SMS message delivery for your organization.

You can configure the following properties:

  • Global notification settings. Settings for each notification type, which indicate whether to send or suppress the notification type globally (to all applicable users) or to allow individual users to choose whether to receive the email notification.
  • Email administrator's password. You can change the email administrator's password.
  • Maximum email queue threads. The maximum number of email threads to create when sending email and SMS messages. The default is 10 threads.
  • Maximum queue elements per thread. Email messages are sent in batches, by thread. The maximum number of messages that each thread must send in each batch. The default is 30 messages.
  • Queue dispatcher sleep period. The time period, in seconds, that the dispatcher must sleep between sending email and SMS messages, to allow other threads to complete sends before removing queued messages. The default is 5 seconds.
  • Queue hanging timeout period. The time period, in seconds, that the dispatcher must wait before deciding that the email host or SMS gateway is not responding and queue messages. The default period is 15 seconds.
  • Queue storage directory. The directory, located under the EDX_HOME\config\ directory (or the EDX_HOME\config\ directory on Windows), used to temporarily store undeliverable email and SMS messages. The default value is mailqueue. In the path, is the directory where you installed Oracle Self-Service E-Billing.

To configure an email host and other messaging properties

  1. Open the notification.cfg.xma.xml file, which can be found in the EDX_HOME/xma/config/com/edocs/common/notification directory (or the EDX_HOME\xma\config\notification directory on Windows). In the path, EDX_HOME is the directory where you installed Oracle Self-Service E-Billing.
  2. To specify global settings for each notification type valid in your edition of Oracle Self-Service E-Billing (Business or Consumer), specify one of the following values under the globalEmailNotificationConfigMap and globalSMSNotificationConfigMap properties:
    • True. All applicable users receive the email or SMS type. Individual users cannot set a preference.
    • False. The email or SMS notification type is not generated globally. Individual users cannot set a preference.
    • notSet. No global setting is specified. Individual users can set their own preference.

      For example, the following code shows where you specify the email global setting for the bill-ready notification type:

    - <property name="globalEmailNotificationConfigMap">

    - <map merge="default">

    - <!-- Key/value for Bill Ready Notification

    Only those settings for notification types valid in your edition are recognized. For information about valid email notification types in the Business Edition, see Email Notification Template Content in the Business Edition. For information about valid email notification types in the Consumer Edition, see Email Notification Template Content in the Consumer Edition.

  3. To update any of the following email notification properties, specify the value under the corresponding property in the notification.cfg.xma.xml file.
    Email Notification Property Function
    Property Name in the notification.cfg.xma.xml File

    Email administrator's password.

    mail.password

    Maximum number of concurrent email queue threads.

    mailQueueThreadMax

    Maximum number of queue elements per thread. Each outgoing email thread receives a batch of notification records from the Messenger_Queue_Table database table, then sends the notifications. This parameter is the notification record count for a batch.

    mailQueueElementsPerThread

    Queue dispatcher sleep period, in seconds. When all email threads are running and there still are more notification records need be sent, the period the dispatcher waits for a free thread to process the next batch of notification records.

    mailQueueDispatcherSleepPeriod

    Queue hanging timeout period.

    mailQueueHangingTimeout

    Queue storage directory, used by the Notifier job. The NotificationComposer task composes a collection of email and save it to a temporary path. The NotificationDispatcher task loads the email file in this path then sends the notifications. Only a single level directory for this path is supported.

    mailQueueStorageDirectory

Implementation Guide for Oracle Self-Service E-Billing Copyright © 2013, Oracle and/or its affiliates. All rights reserved. Legal Notices.