Difference between revisions of "SystemEvents/EventTypes"
| Line 181: | Line 181: | ||
This event can be triggered when a new package is activated, and could be used to send an email to the customer. | This event can be triggered when a new package is activated, and could be used to send an email to the customer. | ||
| − | |||
| + | === Move Customer Profile And Group For Overdue Invoices === | ||
| − | + | ---- | |
Monitor invoices which are overdue by the INVOICE OVERDUE PARAMETER to change group and profile. | Monitor invoices which are overdue by the INVOICE OVERDUE PARAMETER to change group and profile. | ||
Revision as of 13:32, 24 November 2014
Contents
- 1 Event Types
- 1.1 Introduction
- 1.2 Account Creation
- 1.3 Account Status Change
- 1.4 Account Add Package Subscription
- 1.5 Account Package Migration
- 1.6 Account Password Change
- 1.7 Auto Suspend
- 1.8 Auto UnSuspend
- 1.9 Payment plan transaction has failed
- 1.10 Payment plan has been completed
- 1.11 Payment plan has been cancelled
- 1.12 Payment plan has been created
- 1.13 Cancelled Package
- 1.14 Forgotten Password - SMS Password
- 1.15 Forgotten Password - Email reset link
- 1.16 Invoice Post
- 1.17 Invoice Delivery
- 1.18 Invoice Due
- 1.19 Invoice Overdue
- 1.20 Credit Card Expiry
- 1.21 Credit Limit Exceeded
- 1.22 Automated Payment Received
- 1.23 Manual Payment Received
- 1.24 Payment Failed
- 1.25 Shape Bolt On
- 1.26 Unshape Bolt On
- 1.27 Shape Valid Service
- 1.28 Remove Shaping from Valid Service
- 1.29 Usage Threshold (Shaping)
- 1.30 Usage Over Limit (Shaped)
- 1.31 Rolling Usage Threshold
- 1.32 Auto Renew Account Credit
- 1.33 Re-Rating Invoice Complete
- 1.34 Re-Rendering an Invoice from UI
- 1.35 Package Activated
- 1.36 Move Customer Profile And Group For Overdue Invoices
- 1.37 See also
Event Types
Introduction
Events types are defined by Emersion and determine the condition, or conditions, each event will be triggered. As mentioned in the introduction, there are two broad categories of events, account or process centric. Within each event category, there are many event types, each with a set of specific, system defined trigger points or conditions. The event is triggered when all the trigger conditions are met. For example, the overdue invoice event may have trigger conditions based on the number of days overdue, the amount overdue and the number of overdue invoices.
The following event types are currently available:
- Account Creation
- Account Status Change
- Account Add Package Subscription
- Account Package Migration
- Account Password Change
- Auto Suspend
- Auto UnSuspend
- Shape Bolt-On
- Unshape Bolt-On
- Cancelled Package
- Forgotten Password - SMS Password
- Forgotten Password - Email reset link
- Invoice Post
- Invoice Delivery
- Invoice Due
- Invoice Overdue
- Credit Card Expiry
- Credit Limit Exceeded
- Automated Payment Received
- Manual Payment Received
- Payment Failed
- Payment plan transaction has failed (version 2 only)
- Payment plan has been completed (version 2 only)
- Payment plan has been cancelled (version 2 only)
- Payment plan has been created(version 2 only)
- Shape Valid Service
- Remove Shaping from Valid Service
- Usage Threshold (Shaping)
- Rolling Usage Threshold
- Usage Over Limit (Shaped)
- Auto Renew Account Credit
- Re-Rated Invoice Complete
- Re-Rendering an Invoice from UI
- Package Activated Event
- Move Customer Profile And Group For Overdue Invoices
Additional event types may become available in the future. See below for more information about each event type.
Account Creation
When a new customer account is created, this event can be triggered to send an email to the customer e.g. welcome pack, FAQs, contact numbers and other new account details.
Account Status Change
When a customer’s account status changes (i.e. active / inactive) this event can be triggered to inform the customer of the changes. For example, when a customer’s account is made active after being inactive for whatever reason, you could send them message.
Account Add Package Subscription
This event can be triggered when a new package is purchased to send information to the customer e.g. usernames, service setup information etc.
Account Package Migration
This event can be triggered when a customer’s existing package is migrated to a new package e.g. when the customer upgrades or chooses other service packages etc. The new package details and related information could be sent to the customer.
Account Password Change
This event can be triggered when the customer changes their account password via the End User Portal e.g. to send a confirmation to the user as well as notify your support staff.
Auto Suspend
This is a service-based event and is used to automatically restrict the customer's service for non-payment.
Requires subscription to the Automatic Account Suspension and Restriction feature.
Auto UnSuspend
This is a service-based event and is used to automatically lift the restrictions that have been placed on a customer's service.
Payment plan transaction has failed
Notifies the customer when a payment created as a result of a payment plan has failed. Requires subscription to the Payment Plans v2.
Payment plan has been completed
Notifies the customer when the payment plan has been completed. For example, when all payments for the payment plan are successful and nothing further is owing. Requires subscription to the Payment Plans v2.
Payment plan has been cancelled
Notifies when the payment plan has been cancelled before the payment plan has been completed. This can be cancelled either by an Operator or by the system where there are too many failed payments. Requires subscription to the Payment Plans v2.
Payment plan has been created
Notifies when a new payment plan has been created. Requires subscription to the Payment Plans v2.
Cancelled Package
If a package is cancelled, this event can be triggered to confirm the services cancellation, and inform the customer of the final balance.
Forgotten Password - SMS Password
Sending the customer a new password via SMS.
Forgotten Password - Email reset link
Sends the customer a link so that they can reset their password to the End User Portal.
Invoice Post
When the billing system has completed an invoice run, and there are invoices with the delivery method of ‘post’ (i.e. to physically send paper invoices to customers in the mail), this event can notify an Emersion user via email that the invoices are ready to be sent, as well as send all the invoices as attachments to be printed and posted.
Invoice Delivery
When the billing system has completed an invoice run, and there are invoices created with the delivery method of ‘email’, this event can trigger an email to be sent to the customer with the invoice attached.
Invoice Due
This event can be triggered on or after the invoice due date when payment has not been received e.g. email the customer a reminder note. The number of days from the invoice due date to trigger the event can be configured.
Invoice Overdue
Similar to the ‘Invoice Due’ event, this event can be triggered when the invoice due date has past and payment has not been received e.g. email the customer an overdue reminder note. The number of days from the invoice due date to trigger the event can be configured.
Credit Card Expiry
This event examines each customer account to determine whether the credit card expiry date recorded is approaching and if so to trigger an action. For example, when a customer’s credit card is within 2 months of expiry, send an email to prompt the customer to provide updated credit card details. The number of months before the expiry date, as well the ability to trigger multiple events at different points (e.g. at 2 months, at 1 month, and on the expiry month) can be configured.
Credit Limit Exceeded
This event is triggered when an account's outstanding balance exceeds the account's credit limit.
Automated Payment Received
When an automated payment has been successfully processed by the system, this event can be triggered to send a message and receipt details to the customer to confirm that the payment has been completed, as well as notify your accounts receivable staff.
Manual Payment Received
When a payment has been successfully processed manually by an Emersion user in the system, this event can be triggered to send a message and receipt details to the customer to confirm that the payment has been completed, as well as notify your accounts receivable staff.
Payment Failed
When an automated payment cannot be processed by the system, this event can be triggered to send a message to the customer to notify that the payment has failed, as well as notify your accounts receivable staff.
Shape Bolt On
Finds customers whose current bolt on usage exceeds the Shaping Limit as defined in the bolt on. This will then send the request to shape the customer’s service.
Unshape Bolt On
Finds customers whose services are currently shaped by the ‘Shape Bolt On’ event but whose usage in the current period is now below the shaping threshold. This will then send the request to lift the shaping on the customer’s service
Shape Valid Service
This event examines service usage and triggers when the usage amount has reached the monthly allowance as set on the service plan. The system then shapes the service (i.e. by interfacing with the Radius server).
Remove Shaping from Valid Service
This event is closely linked to the ‘Shape Valid Service’ event, and triggers when the usage period of a shaped service rolls over to the next usage period (e.g. at the beginning of the month). The system then removes the shaping that was previously applied to the service.
Usage Threshold (Shaping)
This event is used to examine and monitor usage data and trigger when a particular percentage of the service usage allowance for the period has been reached. For example, trigger an event when a DSL service’s usage reaches 75% of the monthly quota. Multiple trigger points may be set up e.g. one for 75% of usage allowance used, and another at 90% etc.
Usage Over Limit (Shaped)
This event triggers when the usage of a service has exceeded the service usage allowance for the period i.e. at 100% of usage.
Rolling Usage Threshold
This event is used to examine and monitor usage data to identify unexpected or sudden changes in a customer’s service usage. Every day, the system calculates a rolling 30 day total of the service usage and then examines the current calculated amount with the previous day’s amount, and triggers the event when a particular threshold is reached. For example, if the rolling 30 day total of data used yesterday compared to the rolling 30 day total of data used today changes from say 80% yesterday to 100% today, the event can trigger to notify the customer. Usage thresholds can be specified separately for data upload, data download, and telephony.
Auto Renew Account Credit
The ‘Auto Renew’ event is primarily used for pre-paid services. When the service usage has met a particular threshold (e.g. pre-paid credit expiry in 10 days, or 10 hours credit remaining), this event can trigger an automatic renew or purchase of further prepaid credit. This event could also be used to prevent further usage on the service.
Re-Rating Invoice Complete
When you audit your invoices following a bill run, some invoices may have fees, charges, or rates that were incorrect. After you have made the necessary corrections (e.g. update the product rate cards etc.) you can click the ‘Re-Rate’ button to have the invoice charges recalculated by the system. This event is triggered once the system has completed re-rating the invoices and can be used to notify your billing staff to review the updated invoices.
Re-Rendering an Invoice from UI
When updates have been made to invoices following a bill run (e.g. adding or modifying cardlines etc.) you can click the ‘Re-Render’ button to have the invoice re-created by the system. This event is triggered once the system has completed re-rendering the invoices and can be used. to notify your billing staff to review the updated invoices.
Package Activated
This event can be triggered when a new package is activated, and could be used to send an email to the customer.
Move Customer Profile And Group For Overdue Invoices
Monitor invoices which are overdue by the INVOICE OVERDUE PARAMETER to change group and profile.
See also
