Configuring Event Notification
During the life cycle of a subscription, there is a set of standard events that eventually happen with it. The most important of them are:
- Creation completed – this event signifies that services had been successfully provisioned. At this point, it is common to notify customer. Notification methods may differ for service subscriptions and for domain subscriptions. For service subscriptions, the notification assigned to service plan is used. For domain subscriptions, two separate notification templates have to be created (one for successful registration and one for successful transfer). After these thee notification templates are ready, it is time to add three event handlers in "Creation completed" event. For instructions on step-by-step configuration of these notifications, refer to Configuring Notification on Successful Services Provisioning section further in this chapter. Same notification template for all notifications can also be used. In this case, the notification template assigned to service plan is used.
- Scheduled subscription notification – this event signifies that one of a subscription schedule notifications is sent.
- Subscription passed expiration date – this event is activated on the subscription expiration date. This event is most usually handled by notification schedule, which has a great advantage of assigning different notifications to different service plans and periods. Attaching a notification directly to this event will lead to sending the same notification for all subscriptions.
- Subscription passed shutdown date – this event is activated on the subscription shut-down date (after its grace period).
- Subscription passed terminate date – this event is activated on the subscription termination date (after hold period).
- Operations domain registration failed – this event occurs when Operations fails to register domain for a service subscription (often, due to there is a domain with same name already registered).
Step by step instruction below is suitable for the last two events. Configuring notification for the first type is described separately. The second event is rarely required to be notified of.
To assign a notification to the following events:
- Subscription Put On Administrative Hold
- Subscription Put On Credit Hold
- Subscription Put On Hold
- Subscription Taken From Administrative Hold
- Subscription Taken From Credit Hold
- Subscription Taken From Hold
- Open System > Settings > Events > Event Handlers. The list of event handlers available in the system appears on the screen.
-
Click Add New Event Handler. The adding new event handler dialog window is displayed. Fill out the form:
- Click
next to the Event type list. From the window that opens, select event type. - Type the name of programmatic object to be created into the Object field. For notifications it is MESSAGE.
- Type the name of object's method to be called when the event occurs into the Method field. For subscription notification, it is SubscriptionNotification.
-
Type the signature of the method into the Signature field. It should contain the following row (replace TemplateName with the appropriate order notification template name without quotation marks): integer subscriptionID, string TemplateName=Subscription Expires.
Note: This field is case-sensitive.
- Select the Stellart protocol from the Protocol menu.
- Type the number of attempts the handler will make in case an error occurs into the Max Attempts field. For messaging it is normally "1".
- Type how frequently (in seconds) the retry attempts should be made into the Repeat Interval field. As notifications normally do not use retries, this setting is not important and can be "1".
- The Synchronous option indicates how the handler should be executed – synchronous or asynchronous. To prevent unnecessary delays in event processing, notifications should be sent asynchronously (check box has to be cleared).
- The Delay (hours) option sets by how many hours the handler execution should be delayed. There is no need to have any delays, so you can leave the option blank.
- The Priority parameter defines the events processing order. "1" is the highest priority. All tasks of the event receive the same priority. When there two or more events having the same priority occur, the newest tasks are processed first (not those that occurred first!).
- Click
- Click Save to finish configuring the event notification.