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 type settings. The settings for each notification type, which indicate whether to send or suppress the notification type for all applicable users or allow individual users to choose whether to receive the notification.
• Maximum email queue threads. The maximum number of message 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 used to temporarily store undeliverable email and SMS messages. The default value is mailqueue. The queue storage directory is located in the following directory:
  • UNIX. EDX_HOME/config/
  • Windows. EDX_HOME\config\

To configure messaging properties

1. Edit the notification.cfg.xma.xml file, located in the following directory:
   • UNIX. EDX_HOME/xma/config/com/edocs/common/notification
   • Windows. EDX_HOME\xma\config\com\edocs\common\notification
2. To specify global settings for each notification type valid in your edition of Oracle Self-Service E-Billing, specify the following values under the preference bean for each notification type. Each notification type is defined as a bean under the notificationPreferenceConfig property in the NotificationPreferenceManagerTarget bean.

   Notification Configuration Property	Description
   sms	The preference setting for an SMS notification of this message type: True. All applicable users receive the SMS notification type. Individual users cannot set a preference. False. The 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.
   selectedByDefault	The preference setting for email notification of this message type: True. All applicable users receive the email notification type. Individual users cannot set a preference. False. The email 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.
   ADAOnly	This preference setting indicates that this notification is displayed only in the Billing and Payment application when the user is ADA enabled.
   resource	The resource bundle of the message shown on the notification preference UI page inthe Billing and Payment application. This resource bundle is used to automatically generate the notification preference page. If a new notification without a special preference parameter, such as numDaysBeforeDueDate, is later added to the page, then the JSP does not have to change. If this property is not specified, then the preference will not appear in in the UI.
   additionalParams	Additional parameters required by this notification template, such as numDaysBeforeDueDate in paymentDueNotification, which you can be extended.
   emailCheckBoxTitle	To support ADA, this property adds the title of email checkboxes to the user notification configuration page in the Billing and Payment application.
   smsCheckBoxTitle	To support ADA, this property adds the title of sms checkboxes to the user notification configuration page in the Billing and Payment application..

   For example, the following code in the notification.cfg.xma.xml file shows where you specify the global properties for the bill-ready notification type:

   bean id="NotificationPreferenceManagerTarget" class="com.edocs.common.notification.core.NotificationPreferenceManager" scope="singleton" lazy-init="default" autowire="default" dependency-check="default">

   - <!-- notification preference setting, this configuration can enable/disable certain notification for all users on specified channel

   -->

   - <property name="notificationPreferenceConfig">

   - <list merge="default">

   - <bean id="BillNotificationConfigBean" class="com.edocs.common.notification.config.PreferenceBean" lazy-init="default" autowire="default" dependency-check="default">

   - <!-- Notification preference name

   -->

   - <property name="name">

   <value>newStmtAvailable</value>

   </property>

   - <!-- sms notification preference setting. Its value specifies enable/disable this message sending for certain channel.

   -->

   - <property name="sms">

   <value>notSet</value>

   </property>

   - <!-- email notification preference setting. Its value specifies enable/disable this message sending for certain channel.

   -->

   - <property name="selectedByDefault">

   <value>notSet</value>

   </property>

   - <!-- Resource bundle of message which is shown in E-Billing notification preference UI page. It is used to automatically generate notification preference page.

   -->

   - <property name="resource">

   <value>user.message.notification.billReady</value>

   </property>

   - <property name="emailCheckBoxTitle">

   <value>global.label.billReady</value>

   </property>

   - <property name="smsCheckBoxTitle">

   <value>global.label.billReadySMS</value>

   </property>

   </bean>

   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.

   Property Name	Email Notification Property Function
   mailQueueThreadMax	The maximum number of concurrent email queue threads.
   mailQueueElementsPerThread	The maximum number of queue elements for each 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.
   mailQueueDispatcherSleepPeriod	The queue dispatcher sleep period, in seconds. When all email threads are running and there more notification records must still be sent, then this function defines the period the dispatcher waits for a free thread to process the next batch of notification records.
   mailQueueHangingTimeout	The queue delay timeout period.
   mailQueueStorageDirectory	The 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.
   maxEntriesPerUser	The maximum number of entries that can be consolidated.