Administration Guide for Oracle Self-Service E-Billing > Configuring Jobs > Billing Job Types >

Configuring a Notifier Job


The Notifier job extracts the email address registered for each bill-ready account and composes a single, consolidated email for the address. The Notifier job then sends the composed email to the recipients.

To send queued email messages, you must run Notifier after any job that was configured to generate email notifications. You can configure Notifier to run for all notification types or for one particular type of message only, such as:

  • Payment reminders
  • A payment is due
  • A statement is ready
  • A user's credit card expires
  • User enrolls in an account
  • User updates a personal profile
  • User creates, updates or deletes a payment account
  • User makes an instant payment
  • User schedules a one-time or recurring payment

The types of notifications you can send are listed in the Notifier task parameters.

The Notifier job sends email based on entries that are stored in the MESSENGER_GROUP_TABLE table in the OLTP database, composes the correct email message based on email templates, and sends it to the users to whom the messages are addressed.

The Notifier job consists of two tasks:

  • NotificationComposer
  • NotificationDispatch

Configuring the NotificationComposer Task

The NotifierComposer task extracts the email address registered for each bill-ready account and composes a single, consolidated email for the address. It writes the email message to the location specified and stores the name of the email file and the email address in MESSENGER_QUEUE_TABLE.

This task references the MESSENGER_GROUP_TABLE table. For each entry with a value in MESSAGE_TYPE matching the Message type parameter value, the task composes the corresponding email message and stores the composed message in the local message repository. The repository file directory is specified in the EDX_HOME/xma/config/com/edocs/common/notification/notification.xma.xml file, in the GlobalConfigurationBean section with the bean configuration property value of mailQueueStorageDirectory. In the path, EDX_HOME is the directory where you installed Oracle Self-Service E-Billing. The location of the message file is in the MESSENGER_QUEUE_TABLE table.

To send and receive email, you must configure the Notification.xma.xml file for the email address and password (mail.user and mail.password values).

To configure the Notification.xma.xml file

  • Edit the notification.xma.xml file, found in the EDX_HOME/xma/config/com/edocs/common/notification directory. Specify the mail.user and mail.password values:

    <prop key="mail.host">stbeehive.yourcompanydomain.com</prop>

    <prop key="mail.transport.protocol">SMTP</prop>

    <!-- For requiring authentication mail server -->

    <prop key="mail.smtp.auth">true</prop>

    <prop key="mail.user">eBillingAdmin_WW@yourcompanydomain</prop>

    <prop key="mail.password">eBilling603</prop>

    <!-- For SSL connection mail server-->

    <prop key="mail.smtp.socketFactory.class">javax.net.ssl.SSLSocketFactory</prop>

    <prop key="mail.smtp.socketFactory.port">465</prop>

    </props>

Parameters for Configuring the NotificationComposer Task

Table 6 describes the configuration parameters for the NotificationComposer task.

Table 6. Parameters for Configuring the NotificationComposer Task
Parameter
What to Enter or Select

Skip task

When set to the default value N, the task is not skipped when running the Notifier job. Otherwise, the job is not executed.

Message type

This value specifies the types of messages that the Notifier job picks up when it runs. (This list comes from the notification.xma.xml configuration file, in the section of GlobalConfigurationBean with the bean configuration property value of notifierMessageTypes. The notification.xma.xml file is located in the EDX_HOME\xma\config\com\edocs\common\notification, directory, where EDX_HOME is the directory where you installed Oracle Self-Service E-Billing.)

You must run the appropriate notification jobs before running Notifier.

Table 7 Describes the valid message types you can specify in the Message type field for the NotificationComposer task.

Table 7. Message Types
Message Type
Description

AllNotifications

All email notification types.

BillNotification

Statement-available notifications only.

CreditCardExpiryNotification

For pmtCreditCardExpNotify job notifications only.

BatchReportReadyNotification

This message is populated in the MESSENGER_GROUP_TABLE after running the batch report job successfully. Run the Notifier job to send the actual email to the recipients. Users who created the batch report receive the message.

PaymentDueNotification

For PaymentDueNotification job notifications only.

PaymentScheduledNotification

Notifications for scheduled payments from the pmtPaymentRecurringPayment job only.

PaymentSuccessNotification

Notifications for successful payments from the pmtPaymentReminder job only.

PaymentFailureNotification

Notifications from the pmtPaymentReminder job for failed payments only.

PaymentThresholdNotification

Notifications from the pmtPaymentRecurringPayment job for scheduled payments that have reached the user's threshold only.

RecurringPaymentNotification

This message is populated in the MESSENGER_GROUP_TABLE after a recurring payment has been set up from Oracle Self-Service E-Billing. Run the Notifier job to send the actual email message to the recipients. Users who have access to the billing account through billing hierarchy receive this email.

RecurringPaymentUpdateNotification

This message is populated in the MESSENGER_GROUP_TABLE after a recurring payment is updated. Run the Notifier job to send the actual email message to the recipients. Users who have access to the billing account through billing hierarchy receive this email.

RecurringPaymentDeleteNotification

This message is populated in the MESSENGER_GROUP_TABLE when a recurring payment is deleted. Run the Notifier job to send the actual email message to the recipients. Users who have access to the billing account through billing hierarchy receive this email.

QuickPayment Notification

This message is populated in the MESSENGER_GROUP_TABLE when a one-time payment has been made from Oracle Self-Service E-Billing. Run the Notifier job to send the actual email message to the recipients. Users who have access to the billing account through billing hierarchy receive this email.

EnrollmentNotification

This message is populated in the MESSENGER_GROUP_TABLE when a new user is enrolled in Oracle Self-Service E-Billing. Run the Notifier job to send the actual email message to the recipients.

NotificationComposer

Option to skip the NotificationComposer task when the Notifier job runs. To skip the task, specify Y, otherwise leave as default (N).

PasswordExpiredNotification

This message goes to system administrator users to warn them that their Command Center password is set to expire. Run the PasswordExpNotifier job before running the Notifier job to send the actual email message to the recipients.

Parameters for Configuring the NotificationDispatcher Task

The NotificationDispatcher task sends email messages that are prepared by the NotificationComposer task to the corresponding end users. The detail implementation logic can vary depending upon the implementation Java class provided by the input parameter value.

The default implementation class is com.edocs.common.notification.queue.QueueDispatcher. In this implementation it looks for entries that are stored in MESSENGER_QUEUE_TABLE and sends email to the user for each entry. If email sending fails, then the message entry stays in the MESSENGER_QUEUE_TABLE until it is sent in the next attempt. Based on the task parameter value, the entry can be removed from the table and from the message repository after the message is sent successfully.

Table 8 describes the configuration parameters for the NotificationDispatcher task.

Table 8. Parameters for Configuring the NotificationDispatcher Task
Parameter
What to Enter or Select

Implementation of Interface IDispatcher

The class performs the dispatch function. The default class is com.edocs.common.notification.queue.QueueDispather. If you need to alter the logic to send email, provide your own implementation class and enter the full class path in this field.

Skip task

When set to the default value of N, the task runs (not skipped).

Cleanup messages after successful delivery

When set to the default value of Y, the task deletes the message from the MESSENGER_QUEUE_TABLE table and from the message repository.

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