Difference between revisions of "SystemEvents/EventTypes"

From Emersion
Jump to: navigation, search
(=Unshape Bolt On)
 
(18 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{DISPLAYTITLE:All Event Types}}
+
=This Content Has Moved House=
  
= Overview =
+
This article has been moved to our new home for documentation and help content, the new Emersion Knowledge Base.
This page lists all event types in Emersion.\
 
  
== Event vs Event Type ==
+
We are sorry for the untidiness while we are shifting locations and we appreciate your patience during the transition to our new home.
Each event provided to you to customise and use is known in Emersion as an 'Event Type'. An Event type is designed and developed by Emersion. The event type knows what triggers it needs in order to fire, what thresholds if any are supported and defines the template variables that are available.
 
  
Emersion provide a standard suite of event types for you to tailor and customise. Emersion may also enable other event types upon request, or if you subscribe to additional modules. Emersion can also work with you to develop your own bespoke event type if your needs are very specific. Subscribers cannot create their own event types in the system.
+
[https://resources.emersion.com/display/EKB/Common+Events Take me to the Emersion Knowledge Base article]
  
An 'Event' is an instance of an Event type. For example, you may set up and enable the '''Event Type: Account Creation''' so that each time a new end-user is created in Cumulus, the system is triggered to generate and send the customer a welcome email. In this case, each time a new account is created an ''instance'' of the event type is generated and sent.  The event itself is the generated email sent to the customer.
+
[[file:new_home_sm.jpg|900px]]
 
 
= All Event Types =
 
Check back regularly to see new Event Types as they become available.
 
 
 
===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 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 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.
 
 
 
===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.
 
 
 
===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.
 
 
 
===Automatic Payment Set up Notification event===
 
 
 
This event sends a notification when an automated payment method is enabled for an account.
 
 
 
===Auto Renew Account Credit===
 
 
 
This 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 pre-paid credit. This event could also be used to prevent further usage on the service.
 
 
 
While similar in nature to the auto top-up events described below, it is not the same. This is a '''service-based''' event, whereas the auto top-up features and events are account-based.
 
 
 
===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 [[Provisioning/AutomaticSuspensionAndRestriction | Automatic Account Suspension and Restriction]] feature.
 
 
 
===Auto Top-up credit limit threshold notification warning===
 
 
 
This account-based event is triggered when a customer's credit limit threshold is reached and sends a notification by SMS or email.
 
 
 
Requires subscription to the [[Account_Management/Auto_Top-up | Auto Top-Up]] feature.
 
 
===Auto Top-up credit limit initiate payment===
 
 
 
When the customer's account balance drops below the auto top-up threshold amount, this event will automatically take a payment.
 
 
 
Requires subscription to the [[Account_Management/Auto_Top-up | Auto Top-Up]] 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.
 
 
 
Requires subscription to the [[Provisioning/AutomaticSuspensionAndRestriction | Automatic Account Suspension and Restriction]] feature.
 
 
 
===Automatic Payment Set Up Notification===
 
 
 
Sends a notification when an automated payment method is enabled for an account
 
 
 
===Bolt-on Add-ons Activation event===
 
 
 
This event sends a notification when a bolt-on add-on is activated.
 
 
 
===Bolt-on Add-ons Usage Notification Alerts====
 
 
 
For subscribers to bolt-on add-ons and the TCP (Trade Consumer Protection) events, a new TCP event is available for alerting customers regarding bolt-on add-on usage. Like the Service, Bolt-on and Data TCP events, the default percentage thresholds given are 50%, 85% and 100%. Service providers can request additional thresholds if required.
 
 
 
===Bulk Upload Processing Notification===
 
 
 
This event is used with several of the bulk import and bulk update tools within Cumulus. It is triggered once an upload file has been parsed by the system and sends the results of the import via email to a nominated user.
 
 
 
[[Data_Import | Learn more about what you can update and import in bulk]]
 
 
 
===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.
 
 
 
===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.
 
 
 
===Forgotten Password - Email reset link===
 
 
 
Sends the customer a link so that they can reset their password to the End User Portal.
 
 
 
===Forgotten Password - SMS Password===
 
 
 
Sending the customer a new password via SMS.
 
 
 
===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.
 
 
 
=== 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.
 
 
 
=== Move Customer Profile And Group For Overdue Invoices ===
 
 
 
Part of the suite of debt collection management events, this event monitors for customers with overdue invoices. It requires the following 3 parameters to be set in the event mapping:
 
* Invoice Overdue Parameter
 
* Account Profile ID
 
* Account Group ID
 
When a customer has an unpaid invoice that exceeds this Invoice Overdue Parameter and is not already already assigned to the nominated Account Profile and/or Account Group, the event will move them into these profile and group accordingly.
 
 
 
Requires a subscription to [[Account/Account_Groups | Account Groups]]
 
* [[SystemEvents/EventTypes/Move_Customer_Profile_And_Group_For_Overdue_Invoices| Information about Move customer Profile and Group for Overdue Invoices Event]]
 
 
 
=== Move Customer Profile And Group For Up To Date Invoices ===
 
 
 
Part of the suite of debt collection management events and the sister event to ''Move Customer Profile And Group For Overdue Invoices''. When the end user no longer meets the conditions of the trigger, the former profile and group settings will be restored via this event.
 
 
 
Requires a subscription to [[Account/Account_Groups | Account Groups]]
 
 
 
===Package Activated===
 
 
 
This event can be triggered when a new package is activated, and could be used to send an email to the customer.
 
 
 
===Payment Extension===
 
 
 
Informs the customer that their invoice due date has been extended. Requires subscription to [[InvoiceManagement/Payment_Extensions | Payment Extensions]]
 
 
 
===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.
 
 
 
===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.
 
 
 
===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.
 
 
 
===Payment Plan has been Created===
 
 
 
Notifies when a new payment plan has been created. Requires subscription to Payment Plans.
 
 
 
===Payment plan transaction has failed===
 
 
 
Notifies the customer when a scheduled payment for a payment plan failed. Requires subscription to the Payment Plans.
 
 
 
===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.
 
 
 
===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.
 
 
 
===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 card lines 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.
 
 
 
=== Service Activation ===
 
 
 
This event will send a notification when a new service is activated.
 
 
 
=== Service Type Migrate ===
 
 
 
This event triggers a notification when the service type migration process begins.  Requires separate subscription to [[Main_Page/Provisioning/Service_Type_Migrate | Service Type Migrations]]
 
 
 
===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.
 
 
 
===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).
 
 
 
=== Unbilled Credit Limit Events ===
 
The unbilled credit limit events are a group of Event Types that are concerned with the unbilled credit limit of an account. Unbilled credit is the sum of ACTUAL VALUE + TAX_AMOUNT of the INVOICED_AMOUNT and INVOICED_TAX_AMOUNT of any usage MINUS any unallocated payments (not allocated to invoices). If there are any unallocated payments made against the account these payments will lower the amount of unbilled credit.
 
 
 
If a payment is made and allocated against an invoice, this does not lower the customer's unbilled credit limit. The payment must remain unallocated for it to be counted in the unbilled credit amount. The expected behaviour is that the end user will make an additional payment to put the account in credit and, at the same time, reduce their unbilled credit so that it is under the defined limit.
 
 
 
Unbilled Credit Limit is an attribute against the account which sets the maximum Unbilled Credit which is allowed against the account before further action is taken. The unbilled credit limit for a customer is set on the Customer > Detail > Trading Terms tab|Trading Terms sub tab under the customer]].
 
 
 
The System Events that have been created for this are concerned with a credit limit threshold being reached, the total credit limit being exceeded, services being suspended, and the an unallocatedPayment for the value of the unbilled Credit being made (and associated re-activation of services).
 
 
 
'''Notify Events'''
 
 
 
These events are simply concerned with notifying the customer that a credit limit threshold has been exceeded. These event types are not concerned with barring or unbarring of services. This is handled by other event types listed below.
 
 
 
==== Unbilled Credit Limit - Remove Credit Limit Notification====
 
* Event Type Id 920
 
This event triggers alerts to be sent to end users based on their unbilled Credit Limit reaching a certain threshold as defined in the system event mapping. Emersion can define these thresholds for you. the System Event Mappings for this event type contain a ''Percentage From'' and a ''Percentage To'' threshold.
 
 
 
====Unbilled Credit Limit - Notify of Unbilled Credit limit reached====
 
* Event Type Id 926
 
This event is triggered when an unallocated payment is made against the target account and, as a result, the unbilled credit limit is lowered to below the credit limit thresholds defined in the '''Unbilled Credit Limit - Remove Credit Limit Notification''' event.
 
 
 
'''Barring and unbarring Events'''
 
 
 
These event types are not concerned with barring or unbarring of services.
 
 
 
====Unbilled Credit Limit - Barred Service Monitor====
 
* Event Type Id 922
 
This event type checks for services that are either scheduled to be barred in the future by the ''Unbilled Credit Limit - Scheduled Service Bar event'' or have already been barred by that event type and checks current unbilled amount on the account. There is no notification associated with this event type. In the Event type mapping for this event type, the event type needs to know the Service Feature Type ID for the specific barring product. Emersion will then set up these thresholds in your event type mapping.
 
 
 
Where the unbilled credit amount has been paid off and is below the unbilled credit limit levels defined in the thresholds, this event type will either unbar the service (if it's already barred), or cancel any service barring that is scheduled in the future.
 
 
 
====Unbilled Credit Limit - Scheduled Service Bar====
 
* Event Type Id 921
 
This event type is used to schedule the barring of active service subscriptions attached to an account where the credit limit has been exceeded. The recommended notification for this is Email - as the template will contain a list of services that will be affected by the barring. Service Providers will need to provide Emersion with the ''Service Feature Type Id'' of the barring product, and also the delay (in hours) of the barring taking effect. Emersion will set up the event mapping thresholds for you upon request.
 
 
 
The following event mapping example is for barring a Telstra service 24 hours after the event has been triggered.
 
 
 
<code>
 
<thresholds>
 
<barringFeatureTypeId>1635</barringFeatureTypeId>
 
<parentAccountBaringHours>24</parentAccountBaringHours>
 
</thresholds>
 
</code>
 
 
 
===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
 
 
 
===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.
 
 
 
== Event Variables ==
 
 
 
* Below is a list of event variables for events available in the system.
 
 
 
New Account
 
                new_account_id - Account ID
 
                new_account_name - Account Name
 
                start_date - Account Start Date
 
                cumulusUsername - Cumulus Username
 
                usernameWithoutRealm - Cumulus Username Without Realm
 
                cumulusPassword - Cumulus Password
 
                {$account->exportRef} - Export Reference
 
 
 
Account Status Change
 
                {$account->id} - Account ID
 
                {$account->getShortName()} - Account Name
 
                old_status - Old Status
 
                new_status - New Status
 
                reason - Status Change Reason
 
 
 
Add Package Subscription
 
                package_name - Package Name
 
                customer_account_name - Customer Account Name
 
                customer_account_id - Customer Account Number
 
                package_subscription_id - Package Subscription Id
 
                package_subscription_status - Package Subscription Status
 
                package_subscription_creation_date - Package Creation Date
 
                package_access_fee - Package Access Fee
 
                eme_order_id - EME Order No
 
                {$account->exportRef} - Export Reference
 
 
 
Account Package Migration
 
                old_package_name - Old Package Name
 
                new_package_name - New Package Name
 
                migrate_date - Package Migration Date
 
 
 
Invoice Overdue by X days
 
                Invoice Overdue by X days
 
                {$account->id} - Account ID
 
                {$account->getShortName()} - Account Name
 
                {$contact->firstName} - Contact First Name
 
                {$contact->lastName} - Contact Surname
 
                {$account->getAccountBalanceIncTax()} - Current Account Balance
 
                {$invoice->accountBalanceIncGst()} - Invoice Account Balance
 
                {$invoice->id} - Invoice ID
 
                {$invoice->invoiceDue} - Invoice Due Date
 
                {$invoice->amountExGst()} - Invoice Amount (Exc:GST)
 
                {$invoice->amount()} - Invoice Amount (Inc:GST)
 
                outstandingAmountIncTax - Invoice Outstanding Amount (Inc:GST)
 
                {$account->getOverdueInvoiceAmount()} - Overdue Amount (Ex Tax)
 
                {$account->getOverdueInvoiceAmountIncTax()} - Overdue Amount (Inc Tax)
 
                bpay_ref - Bpay Ref
 
                {$account->exportRef} - Export Reference
 
                amount_payable_ex_tax - Amount Payable Ex Tax
 
                amount_payable_inc_tax - Amount Payable Inc Tax
 
 
 
Credit Card Expiry
 
                months - Months Until Expiry
 
                expiry - Card Expiry Date
 
 
 
Usage warning over x% - calendar month usage
 
                total_allowance - Total Allowance in Mb
 
                service_name - Service Name
 
                total_used - Total Used in Mb
 
                percentage - Percentage Trigger Point
 
                percentage_used - Percentage Actually Used
 
                period_start - Usage Period Start
 
                period_end - Usage Period Finish
 
                time_band - Tariff/Time Band Name
 
 
 
Account Password Changed
 
                service_name - Service Name
 
                username - Username
 
                password - Password
 
                {$account->id} - Account ID
 
                {$account->getShortName()} - Account Name
 
                {$account->getOverdueInvoiceAmount()} - Overdue Amount (Ex Tax)
 
                {$account->getOverdueInvoiceAmountIncTax()} - Overdue Amount (Inc Tax)
 
                bpay_ref - Bpay Ref
 
                {$account->exportRef} - Export Reference
 
 
 
Invoice Due in X days
 
                {$account->id} - Account ID
 
                {$contact->firstName} - Contact First Name
 
                {$contact->lastName} - Contact Surname
 
                {$invoice->id} - Invoice ID
 
                {$invoice->invoiceDue} - Invoice Due Date
 
                {$invoice->accountBalanceIncGst()} - Amount Due (Incl:GST)
 
                {$invoice->amountExGst()} - Invoice Amount (Excl:GST)
 
                {$invoice->amount()} - Invoice Amount (Incl:GST)
 
                {$account->exportRef} - Export Reference
 
                amount_payable_ex_tax - Amount Payable Ex Tax
 
                amount_payable_inc_tax - Amount Payable Inc Tax
 
 
 
Payment Failure Notification
 
                {$account->id} - Account ID
 
                paymentaccountname - Account Name
 
                amount - Payment Amount
 
                payment_date - Payment Date
 
                reference - Transaction Ref
 
                last_comment - Last Gateway Comment
 
                method - Payment Method
 
                {$account->exportRef} - Export Reference
 
 
 
Automated Payment Received
 
                {$account->id} - Account Id
 
                {$account->getShortName()} - Account Name
 
                amount - Payment Amount
 
                payment_date - Payment Date
 
                reference - Transaction Ref
 
                method - Payment Method
 
                {$account->exportRef} - Export Reference
 
 
 
Manual Payment Received
 
                {$account->id} - Account Id
 
                {$account->getShortName()} - Account Name
 
                amount - Payment Amount
 
                payment_date - Payment Date
 
                reference - Transaction Ref
 
                method - Payment Method
 
                {$account->exportRef} - Export Reference
 
 
 
Usage Warning Shaped (over 100%) - calendar month usage
 
                total_allowance - Total Allowance in Mb
 
                total_used - Total Used in Mb
 
                percentage - Percentage Trigger Point
 
                percentage_used - Percentage Actually Used
 
                period_start - Usage Period Start
 
                period_end - Usage Period Finish
 
                time_band - Tariff/Time Band Name
 
 
 
Credit Limit Exceeded - invoice create (Pending Cardline)
 
                customer_account_name - Customer Account Name
 
                amount - Total Credit Amount
 
                {$account->exportRef} - Export Reference
 
 
 
Invoice Delivery (Email)
 
                {$account->id} - Account ID
 
                {$account->getShortName()} - Account Name
 
                {$contact->firstName} - Contact First Name
 
                {$contact->lastName} - Contact Surname
 
                {$account->getOverdueInvoiceAmountIncTax()} - Overdue Amount (Incl:Tax)
 
                {$invoice->previousBalanceIncTax()} - Previous Balance (Incl:Tax)
 
                {$invoice->id} - Invoice ID
 
                {$invoice->invoiceIssue} - Invoice Issue Date
 
                {$invoice->invoiceDue} - Invoice Due Date
 
                {$invoice->accountBalanceIncGst()} - Account Balance (Incl:Tax)
 
                {$invoice->amountExGst()} - Invoice Amount (Excl:Tax)
 
                {$invoice->amount()} - Invoice Amount (Incl:Tax)
 
                bpay_biller_code - BPay Biller Code
 
                bpay_ref - BPay Ref
 
                cumulusUsername - Cumulus Username
 
                paymentsSinceLastInvoice - Payments Received
 
                {$account->exportRef} - Export Reference
 
 
 
Invoice Post
 
                {$account->id} - Account ID
 
                {$contact->firstName} - Contact First Name
 
                {$contact->lastName} - Contact Surname
 
                {$invoice->id} - Invoice ID
 
                {$invoice->invoiceDue} - Invoice Due Date
 
                {$invoice->accountBalanceIncGst()} - Amount Due (Incl:GST)
 
                {$invoice->amountExGst()} - Invoice Amount (Excl:GST)
 
                {$invoice->amount()} - Invoice Amount (Incl:GST)
 
                {$invoice->accountBalanceIncGst()} - Account Balance
 
                cumulusUsername - Cumulus Username
 
                {$account->exportRef} - Export Reference
 
 
 
Usage x% yesterday to y% today - rolling 30 day usage
 
                FNN - FNN
 
                maximum_allowed_value - 30 Day Download Cap
 
                download_data_now - Current Usage Total
 
                percentage_used - Current Percentage Used
 
                tariff_name - Tariff Name
 
                period_starts - Usage Period Start
 
                period_ends - Usage Period Finish
 
 
 
Auto Block Hours Renew
 
                {$account->id} - Account ID
 
                useraccountname - Account Name
 
                username - User Name
 
                userserviceid - Service ID
 
                {$account->exportRef} - Export Reference
 
 
 
Invoice Rerating Complete
 
               
 
                {$account->id} - Account ID
 
                invoice_id - Invoice ID
 
 
 
Cancelled Package
 
                core_identifier - Core Identifier
 
                package_subscription_name - Internal Package Name
 
                {$account->id} - Account ID
 
                {$account->exportRef} - Export Reference
 
 
 
ReRendered Invoice
 
                {$account->id} - Account ID
 
                {$invoice->id} - Invoice ID
 
                invoice_account_name - Account Name
 
                {$account->exportRef} - Export Reference
 
 
 
Package Activated
 
                {$account->id} - Account ID
 
                contact_first_name - Contact First Name
 
                contact_last_name - Contact Last Name
 
                package_access_fee - Package Access Fee
 
                package_plan_external_name - Package Plan External Name
 
                service_core_identifier - Service Core Identifier
 
                contract_pkg_name - Default Package Contract Name
 
                {$account->exportRef} - Export Reference
 
 
 
Exceeding Credit Limit
 
                {$account->id} - Account ID
 
                creditLimit - Credit Limit ($)
 
                totalBalanceAmount - Account Balance (Excl Tax)
 
                totalBalanceTax - Account Balance Tax
 
                totalBalanceAmountIncTax - Account Balance (Inc Tax)
 
                disputedAmount - Account Disputed Amount (Excl Tax)
 
                disputedTax - Account Disputed Tax
 
                creditAccountName - Account Primary Contact Name
 
                {$account->exportRef} - Export Reference
 
 
 
Point of sale receipt
 
                posCustAcctId - Customer Account ID
 
                posCustAcctName - Customer Account Name
 
                posSalesAcctId - Salesperson Account ID
 
                posSalesAcctName - Salesperson Name
 
                posHtmlCart - Full HTML Cart
 
                posPaymentMethod - Payment Method
 
                posPaymentAmount - Full Amount of Receipt
 
                posDateTime - Date/Time of Receipt
 
 
 
Infotranz Gain
 
                arrivalFNN - New FNN Gained
 
                gainingSpName - Gaining SP Name
 
                serviceTypeMapId - Service Type Map ID
 
 
 
Invoice Payment Complete (Email)
 
                {$account->id} - Account ID
 
                {$contact->lastName} - Contact Surname
 
                {$contact->firstName} - Contact First Name
 
                {$invoice->id} - Invoice ID
 
                {$invoice->invoiceDue} - Invoice Due Date
 
                {$invoice->accountBalanceIncGst()} - Amount Due (Incl:GST)
 
                {$invoice->amountExGst()} - Invoice Amount (Excl:GST)
 
                {$invoice->amount()} - Invoice Amount (Incl:GST)
 
                cumulusUsername - Cumulus Username
 
                {$account->exportRef} - Export Reference
 
 
 
Invoice Payment Completed Late (Email)
 
                {$account->id} - Account ID
 
                {$contact->lastName} - Contact Surname
 
                {$contact->firstName} - Contact First Name
 
                {$invoice->id} - Invoice ID
 
                {$invoice->invoiceDue} - Invoice Due Date
 
                {$invoice->accountBalanceIncGst()} - Amount Due (Incl:GST)
 
                {$invoice->amountExGst()} - Invoice Amount (Excl:GST)
 
                {$invoice->amount()} - Invoice Amount (Incl:GST)
 
                cumulusUsername - Cumulus Username
 
                discount_total_amount - Penalty Amount
 
                discount_total_tax - Penalty Amount tax
 
                discountValue - Penalty Value
 
                discountValueType - Penalty Value Type
 
                {$account->exportRef} - Export Reference
 
 
 
Invoice Payment Complete Early (Email)
 
                {$account->id} - Account ID
 
                {$contact->lastName} - Contact Surname
 
                {$contact->firstName} - Contact First Name
 
                {$invoice->id} - Invoice ID
 
                {$invoice->invoiceDue} - Invoice Due Date
 
                {$invoice->accountBalanceIncGst()} - Amount Due (Incl:GST)
 
                {$invoice->amountExGst()} - Invoice Amount (Excl:GST)
 
                {$invoice->amount()} - Invoice Amount (Incl:GST)
 
                cumulusUsername - Cumulus Username
 
                discount_total_amount - Bonus Amount
 
                discount_total_tax - Bonus Amount tax
 
                discountValue - Discount Value
 
                discountValueType - Discount Value Type
 
                {$account->exportRef} - Export Reference
 
 
 
AutoTopUp Service
 
                current_balance - Current Balance
 
                topup_amount - TopUp Amount
 
                new_balance - New Balance
 
                result - Result
 
                message - Message
 
 
 
Report Schedule Message Process
 
                schedule_id - Schedule Id
 
                schedule_name - Schedule Name
 
                report_name - Report Name
 
                output_file - File Name
 
 
 
Daily Work Email for Manual Provisioning services
 
                service_table - Provisioning services List Table
 
 
 
Telephone usage by single call duration
 
                cust_account_id - Account Id
 
                contact_name - Contact Name
 
                fnn_charged - Charged Service
 
                fnn_source - Source
 
                fnn_destination - Destination
 
                tariff_name - Tariff Type
 
                usage - Usage
 
                invoiced_amount - Invoiced Amount
 
                invoiced_tax_amount - Invoiced Tax Amount
 
                duration_limit - Duration Limit
 
                {$account->exportRef} - Export Reference
 
 
 
Telephone usage by single call cost value
 
                cust_account_id - Account Id
 
                contact_name - Contact Name
 
                fnn_charged - Charged Service
 
                fnn_source - Source
 
                fnn_destination - Destination
 
                tariff_name - Tariff Type
 
                usage - Usage
 
                invoiced_amount - Invoiced Amount
 
                invoiced_tax_amount - Invoiced Tax Amount
 
                cost_value_limit - Cost Value Limit
 
                {$account->exportRef} - Export Reference
 
 
 
Telephone usage Event Trigger by call types / tariff
 
                cust_account_id - Account Id
 
                contact_name - Contact Name
 
                fnn_charged - Charged Service
 
                tariff_name - Tariff Type
 
                cost_value_limit - Cost Value Limit
 
                invoiced_amount - Invoiced Amount
 
                invoiced_tax_amount - Invoiced Tax Amount
 
                {$account->exportRef} - Export Reference
 
 
 
Ezidebit Bpay Payment Imports Unprocessed Payments
 
                message - System Message
 
                unprocessed_msg_detail - Unprocessed Details
 
 
 
Ezidebit Bpay Payment Imports Processed Payments
 
                message - System Message
 
                processed_msg_detail - Processed Details
 
 
 
Package Subscription Group - remaining pkg sub cancellation process activated
 
                message - System Message
 
                message_detail - Processed Details
 
 
 
Unbilled Credit Notify Per Account
 
                currentUsageAmount - Current Usage Amount
 
                currentUsageAmountInPercentage - Current Usage Amount in Percentage
 
                unBilledCreditLimit - Credit Alert setup Value
 
                percentageReachedFrom - Percentage Reached From
 
                percentageReachedFromInValue - Percentage Reached From in Value
 
                percentageReachedTo - percentage Reached To
 
                percentageReachedToInValue - percentage Reached To in Value
 
                custId - CustomerId
 
                longName - Long Name
 
                shortName - Short Name
 
 
 
Unbilled Credit Schedule Bar Service
 
                custId - CustomerId
 
                longName - Long Name
 
                shortName - Short Name
 
                serviceDetail - Service Details
 
                unBilledCreditLimit - Credit Alert setup Value
 
                currentUsageAmount - Current Usage Amount
 
                parentAccountBarringHours - Scheduled Service Barring Hours setup Value
 
 
 
Account Invoice Delivery Method Change
 
                custId - CustomerId
 
                custLongName - Long Name
 
                custShortName - Short Name
 
                oldMethod - Old Method
 
                timeDateChanged - Date Changed
 
                newMethod - New Method
 
 
 
Service Subscription Cap Usage
 
                {$account->id} - Account ID
 
                contact_salutation - Contact Salutation
 
                firstname - Firstname
 
                lastname - Lastname
 
                service_subscription_id - Service Subscription Id
 
                ssp_id - Service Subscription Period Id
 
                service_id - Service Id
 
                service_identifier - Service Identifier
 
                period_start - Usage Period Start
 
                period_end - Usage Period Finish
 
                plan_service_external_name - Service Plan External Name
 
                service_cap_base_amount - Included Value Amount
 
                service_cap_amount - Included Value Prorata
 
                included_value_name - Included Value Name
 
                included_value_type_name - Included Value Type Name
 
                rated_amount_total - Rated Amount Total
 
                inc_value_left - Included Value Remaining
 
                percentage_used - Percentage used
 
                percentage_trigger_point - Percentage Trigger Point
 
 
 
Service Bolton Cap Usage
 
                period_ratio - Period Ratio
 
                service_cap_base_amount - Cap Base Amount
 
                service_cap_base_amount_mb - Cap Base Amount in MB
 
                service_cap_amount - Cap Amount
 
                period_start - Usage Period Start
 
                period_end - Usage Period Finish
 
                max_type_name - Max type Name
 
                current_usage - Current Usage
 
                current_usage_mb - Current Usage in MB
 
                percentage_used - Percentage Used
 
                current_usage_left - Current Usage Left
 
                current_usage_left_mb - Current Usage Left in MB
 
                sbs_id - Service Bolt On Subscription Id
 
                ss_id - Service Subscription Id
 
                percentage_trigger_point - Percentage Trigger Point
 
                contact_salutation - Contact Salutation
 
                firstname - Firstname
 
                lastname - Lastname
 
                service_identifier - Service Identifier
 
                days_remaining - Days Remaining
 
                account_id - Account ID
 
 
 
User Password Recover By ServiceNumber
 
                userId - User Id
 
                name - Contact Name
 
                username - User Name
 
                usernameWithoutRealm - User Name Without Realm
 
                newPassword - New Password
 
                custId - Account Id
 
                MobileNumber - Mobile Number
 
                PrimaryIdentifier - Service Primary Identifier
 
                dateRequested - Date Requested
 
                ipAddress - IP Address
 
 
 
Service Ticket Updated
 
                serviceRequestId - Service Request ID
 
                summary - Summary
 
                note-id - Note Id
 
                ticketDetails - Note Details
 
                custId - Account Id
 
                customerShortName - Customer Name
 
                customerContact - Customer Contact
 
                primaryPhone - Primary Phone
 
                email - Email
 
                mobile - Mobile
 
                queue - Queue
 
                noteCategory - Note Category
 
                subCategory - Sub Category
 
                status - Status
 
                urgency - Urgency
 
 
 
Bulk Update Carrier Location Availability
 
                name - Carrier Name
 
                processingSummary - File processed Summary
 
                processingDetail - File processed Detail
 
 
 
Notify Per Service Subscription Based Data Charge ExcessUsage
 
                service_charged - Service Charged
 
                service_identifier - Service Identifier
 
                contact_salutation - Contact Salutation
 
                firstname - Firstname
 
                lastname - Lastname
 
                {$account->id} - Account ID
 
                tariff_name - Tariff Name
 
                period_start - Period Start
 
                period_end - Period End
 
                upload_data - Upload Data
 
                upload_data_in_mb - Upload Data in MB
 
                download_data - Download Data
 
                download_data_in_mb - Download Data in MB
 
                plan_maximum_allowed_value - Plan Maximum Allowed Value
 
                plan_bonus_value - Plan Bonus Value
 
                plan_quota - Plan Quota
 
                charge_download - Charge Download Flag
 
                charge_upload - Charge Upload Flag
 
                chargeable_usage_data - Chargeable Usage Data
 
                chargeable_usage_data_in_mb - Chargeable Usage Data in MB
 
                chargeable_usage_left_in_mb - Chargeable Usage Data Left in MB
 
                chargeable_usage_in_percent - Chargeable Usage in Percentage
 
                service_subscription_id - Service Subscription Id
 
                service_plan_name -  Service Plan Name
 
                percentage_trigger_from - Percentage Trigger From
 
                percentage_trigger_to -  Percentage Trigger To
 
 
 
Notify New Service Custom Price
 
                service_subscription_id - Service Subscription Id
 
                cust_id - Customer ID
 
                cust_name - Customer Name
 
                service_plan_name - Service Plan Name
 
                service_price - Service Plan Price
 
                service_price_tax_type - Service Plan Price Tax Type
 
                custom_price_detail - Overridden Custom Price detail
 
 
 
Notify Migrate Service Custom Price
 
                service_subscription_id - Service Subscription Id
 
                cust_id - Customer ID
 
                cust_name - Customer Name
 
                service_plan_name - Service Plan Name
 
                service_price - Service Plan Price
 
                service_price_tax_type - Service Plan Price Tax Type
 
                custom_price_detail - Overridden Custom Price detail
 
 
 
Notify Upon Paid Purchase
 
                product_purchase_id - Product Purchase ID
 
                product_name - Product Name
 
                selling_account_id - Selling Account ID
 
                selling_account_name - Selling Account Name
 
                buying_account_id - Buying Account ID
 
                buying_account_name - Buying Account Name
 
                invoice_id - Invoice ID
 
                inst_total_amount - Installment Total Amount
 
                inst_base_amnt - Installment Base Amount
 
                installment_period_length - Installment Period Length
 
                inst_tot_amnt_rem - Installment Total Amount Remaining
 
 
 
Get Service Usage By FlagFall or Price And ServiceTypeCategory
 
                qty - Total Call Numbers(qty)
 
                d_s - Date Started
 
                service_subscription_id - Service Subscription Id
 
                custid - Account Id
 
                service_identifier - Service Identifier
 
                contact_salutation - Contact Salutation
 
                firstname - First Name
 
                lastname - Last Name
 
                tariff_id - Tariff ID
 
                tariff_name - Tariff Name
 
 
 
Service Order Progress Updated
 
                custId - Account Id
 
                customer_name - Name
 
                customer_details - Customer Detail Info
 
                service_information - Service Information
 
                service_properties - Service Properties Info
 
                provider_notes_to_customer - Notes and Status Info
 
 
 
Notify Service Subscription Provisioning Halted
 
                custId - Account Id
 
                customer_name - Name
 
                service_type_name - Service Type Name
 
                service_id - Service Id
 
                service_subscription_id - Service Subscription Id
 
                service_plan_name_internal_name - Service Plan Internal Name
 
                service_plan_name_external_name - Service Plan External Name
 
                service_subscription_status - Service Subscription Status
 
                service_subscription_created_date - Service Subscription Created date
 
                service_identifier - Service Identifier
 
 
 
Charge Late Payment Fees For Aged Invoices
 
                custid -  Account ID
 
                invoice_id -  Invoice ID
 
                outstanding_balance_inc_tax -  Outstanding Balance Inc Tax
 
                disputed_balance_inc_tax -  Disputed Balance Inc Tax
 
                inv_actual_outstanding -  Actual Outstanding Amount Inc Tax
 
                inv_due_date -  Invoice Due Date
 
                inv_due_formatted -  Invoice Due Date Formatted
 
                inv_due_days_total -  Overdue Days
 
                late_fee_created -  Late Fee Created Flag
 
                contact_salutation -  Contact Salutation
 
                customer_short_name -  Account Shorten Name
 
                customer_long_name -  Account Full Name
 
 
 
Move Customer Profile And Group For Overdue Invoices
 
                custid -  Account ID
 
                moved_to_group - Moved to Account Group
 
                current_account_profile - Current Account Profile
 
                moved_to_profile - Changed to Account Profile
 
                contact_salutation - Contact Salutation
 
                customer_short_name - Account Short Name
 
                customer_long_name - Account Full Name
 
 
 
Move Customer Profile And Group For Up To Date Invoices
 
                custid -  Account ID
 
                result - Processing Result
 
                contact_salutation - Contact Salutation
 
                customer_short_name - Account Shorten Name
 
                customer_long_name - Account Full Name
 
 
 
Service Configuration Complete
 
                eme_order_id - EME Order ID
 
                customer_account_name - Account Name
 
                customer_account_id -  Account ID
 
                primary_contact_phone_number - Primary Contact Primary Phone Number
 
                primary_contact_mobile_number - Primary Contact Primary Mobile Number
 
                service_id - Service ID
 
                service_identifier - Service Identifier
 
                service_type_id - Service Type ID
 
                service_type_name - Service Type Name
 
                service_subscription_id - Service Subscription ID
 
                service_plan_internal_name - Service Plan Internal Name
 
                service_plan_external_name - Service Plan External Name
 
                package_subscription_id - Package Subscription ID
 
                package_internal_name - Package Plan Internal Name
 
                package_external_name - Package Plan External Name
 
                service_address_site_name - Service Address Site Name
 
                service_address - Service Address
 
                username - Username
 
                password - Password
 
                realm - Realm
 
                service_properties - Service Properties
 
 
 
Auto Suspend Event
 
                service_id - Service ID
 
                customer_short_name - Account Name
 
                customer_account_id -  Account ID
 
                service_identifier - Service Identifier
 
                service_sub_id - Service Subscription ID
 
 
 
Auto UnSuspend Event
 
                service_id - Service ID
 
                customer_short_name - Account Name
 
                customer_account_id -  Account ID
 
                service_identifier - Service Identifier
 
                service_sub_id - Service Subscription ID
 
 
 
User Password Recover By ResetLink
 
                userId - User Id
 
                name - Contact Name
 
                username - User Name
 
                usernameWithoutRealm - User Name Without Realm
 
                requestDate - Date Requested
 
                resetLink - Reset Link
 
                custId - Account Id
 
                ipAddress - IP Address
 
 
 
Plan Included Value Based 100 Percent Used Dollar Remains
 
                {$account->id} - Account ID
 
                {$account->getShortName()} - Account Name
 
                service_identifier - Service Identifier
 
                service_id - Service Id
 
                messageID - Message ID
 
                ratePlanID - Rate Plan ID
 
                MSISDN - MSISDN
 
                thresholdID - Threshold ID
 
                valueBalance - Value Balance
 
                billCycle - Bill Cycle
 
                planValueAllowance - Plan Value Allowance
 
                usedValueBalance - Used Value Balance
 
                excessUsageThreshold - Excess Usage Threshold
 
                TOTALALLOWANCEDOLLARS - Total Allowance Dollars
 
                PERCENTUSED - Percent Used
 
                TOTALALLOWANCEDOLLARS - Total Allowance Dollars
 
 
 
Plan Included Value Based 100 PercentUsed
 
                {$account->id} - Account ID
 
                {$account->getShortName()} - Account Name
 
                service_identifier - Service Identifier
 
                service_id - Service Id
 
                messageID - Message ID
 
                ratePlanID - Rate Plan ID
 
                MSISDN - MSISDN
 
                thresholdID - Threshold ID
 
                valueBalance - Value Balance
 
                billCycle - Bill Cycle
 
                planValueAllowance - Plan Value Allowance
 
                usedValueBalance - Used Value Balance
 
                excessUsageThreshold - Excess Usage Threshold
 
                PERCENTUSED - Percent Used
 
                TOTALALLOWANCEDOLLARS - Total Allowance Dollars
 
 
 
DataPackLessThan100PercentUsedMBRemains
 
                {$account->id} - Account ID
 
                {$account->getShortName()} - Account Name
 
                service_identifier - Service Identifier
 
                service_id - Service Id
 
                messageID - Message ID
 
                ratePlanID - Rate Plan ID
 
                MSISDN - MSISDN
 
                thresholdID - Threshold ID
 
                dataBalance - Data Balance
 
                billCycle - Bill Cycle
 
                planDataAllowance - Plan Data Allowance
 
                usedDataBalance - Used Data Balance
 
                excessUsageThreshold - Excess Usage Threshold
 
                TOTALALLOWANCEMB - Total Allowance MB
 
                PERCENTUSED - Percent Used
 
 
 
DataPack 100 Percent Used
 
                {$account->id} - Account ID
 
                {$account->getShortName()} - Account Name
 
                service_identifier - Service Identifier
 
                service_id - Service Id
 
                messageID - Message ID
 
                ratePlanID - Rate Plan ID
 
                MSISDN - MSISDN
 
                thresholdID - Threshold ID
 
                dataBalance - Data Balance
 
                billCycle - Bill Cycle
 
                planDataAllowance - Plan Data Allowance
 
                usedDataBalance - Used Data Balance
 
                excessUsageThreshold - Excess Usage Threshold
 
                PERCENTUSED - Percent Used
 
                TOTALALLOWANCEMB - Total Allowance MB
 
 
 
Spend Limit Warning for Plan Allowance Includes Current Exceeded Figure And Underlying SpendLimit
 
                {$account->id} - Account ID
 
                {$account->getShortName()} - Account Name
 
                service_identifier - Service Identifier
 
                service_id - Service Id
 
                messageID - Message ID
 
                ratePlanID - Rate Plan ID
 
                MSISDN - MSISDN
 
                thresholdID - Threshold ID
 
                dataBalance - Data Balance
 
                billCycle - Bill Cycle
 
                planDataAllowance - Plan Data Allowance
 
                usedDataBalance - Used Data Balance
 
                excessUsageThreshold - Excess Usage Threshold
 
                PLANEXCEEDAMOUNT - Plan Exceed Amount
 
                SPENDLIMIT - Spend Limit
 
 
 
Service Plan Dollar Value Excess Usage Service Suspended
 
                {$account->id} - Account ID
 
                {$account->getShortName()} - Account Name
 
                service_identifier - Service Identifier
 
                service_id - Service Id
 
 
 
Service Plan Data Shaping Restriction
 
                {$account->id} - Account ID
 
                {$account->getShortName()} - Account Name
 
                service_identifier - Service Identifier
 
                service_id - Service Id
 
 
 
Included Value Dollar Excess Usage Warning
 
                {$account->id} - Account ID
 
                {$account->getShortName()} - Account Name
 
                service_identifier - Service Identifier
 
                service_id - Service Id
 
                messageID - Message ID
 
                ratePlanID - Rate Plan ID
 
                MSISDN - MSISDN
 
                thresholdID - Threshold ID
 
                valueBalance - Value Balance
 
                billCycle - Bill Cycle
 
                planValueAllowance - Plan Value Allowance
 
                usedValueBalance - Used Value Balance
 
                excessUsageThreshold - Excess Usage Threshold
 
                PLANEXCEEDPERCENT - Plan Exceed Percent
 
                TOTALALLOWANCEDOLLARS - Total Allowance Dollars
 
 
 
Included Value Data Excess Usage Warning
 
                {$account->id} - Account ID
 
                {$account->getShortName()} - Account Name
 
                service_identifier - Service Identifier
 
                service_id - Service Id
 
                messageID - Message ID
 
                ratePlanID - Rate Plan ID
 
                MSISDN - MSISDN
 
                thresholdID - Threshold ID
 
                dataBalance - Data Balance
 
                billCycle - Bill Cycle
 
                planDataAllowance - Plan Data Allowance
 
                usedDataBalance - Used Data Balance
 
                excessUsageThreshold - Excess Usage Threshold
 
                PLANEXCEEDPERCENT - Plan Exceed Percent
 
                TOTALALLOWANCEMB - Total Allowance MB
 
 
 
Plan Data Included Value Based 50 Percent Alert MB Remains
 
                {$account->id} - Account ID
 
                {$account->getShortName()} - Account Name
 
                service_identifier - Service Identifier
 
                service_id - Service Id
 
                messageID - Message ID
 
                ratePlanID - Rate Plan ID
 
                MSISDN - MSISDN
 
                thresholdID - Threshold ID
 
                dataBalance - Data Balance
 
                billCycle - Bill Cycle
 
                planDataAllowance - Plan Data Allowance
 
                usedDataBalance - Used Data Balance
 
                excessUsageThreshold - Excess Usage Threshold
 
                PERCENTUSED - Percent Used
 
                TOTALALLOWANCEMB - Total Allowance MB
 
 
 
Plan Data Included Value Based 85 Percent Alert MB Remains
 
                {$account->id} - Account ID
 
                {$account->getShortName()} - Account Name
 
                service_identifier - Service Identifier
 
                service_id - Service Id
 
                messageID - Message ID
 
                ratePlanID - Rate Plan ID
 
                MSISDN - MSISDN
 
                thresholdID - Threshold ID
 
                dataBalance - Data Balance
 
                billCycle - Bill Cycle
 
                planDataAllowance - Plan Data Allowance
 
                usedDataBalance - Used Data Balance
 
                excessUsageThreshold - Excess Usage Threshold
 
                PERCENTUSED - Percent Used
 
                TOTALALLOWANCEMB - Total Allowance MB
 
 
 
Plan Data Included Value Based 100 Percent Used
 
                {$account->id} - Account ID
 
                {$account->getShortName()} - Account Name
 
                service_identifier - Service Identifier
 
                service_id - Service Id
 
                messageID - Message ID
 
                ratePlanID - Rate Plan ID
 
                MSISDN - MSISDN
 
                thresholdID - Threshold ID
 
                dataBalance - Data Balance
 
                billCycle - Bill Cycle
 
                planDataAllowance - Plan Data Allowance
 
                usedDataBalance - Used Data Balance
 
                excessUsageThreshold - Excess Usage Threshold
 
                PERCENTUSED - Percent Used
 
                TOTALALLOWANCEMB - Total Allowance MB
 
 
 
Spend Limit Warning for Plan Allowance
 
                {$account->id} - Account ID
 
                {$account->getShortName()} - Account Name
 
                service_identifier - Service Identifier
 
                service_id - Service Id
 
                messageID - Message ID
 
                ratePlanID - Rate Plan ID
 
                MSISDN - MSISDN
 
                thresholdID - Threshold ID
 
                dataBalance - Data Balance
 
                billCycle - Bill Cycle
 
                planDataAllowance - Plan Data Allowance
 
                usedDataBalance - Used Data Balance
 
                excessUsageThreshold - Excess Usage Threshold
 
                SPENDLIMIT - Spend Limit
 
 
 
Data Usage Exceeded 10 Percent - Shaped
 
                {$account->id} - Account ID
 
                {$account->getShortName()} - Account Name
 
                service_identifier - Service Identifier
 
                service_id - Service Id
 
                messageID - Message ID
 
                ratePlanID - Rate Plan ID
 
                MSISDN - MSISDN
 
                thresholdID - Threshold ID
 
                dataBalance - Data Balance
 
                billCycle - Bill Cycle
 
                planDataAllowance - Plan Data Allowance
 
                usedDataBalance - Used Data Balance
 
                excessUsageThreshold - Excess Usage Threshold
 
                PLANEXCEEDPERCENT - Plan Exceed Percent
 
 
 
IncludedValue Minutes Notify Use
 
                {$account->id} - Account ID
 
                {$account->getShortName()} - Account Name
 
                service_identifier - Service Identifier
 
                service_id - Service Id
 
                messageID - Message ID
 
                ratePlanID - Rate Plan ID
 
                MSISDN - MSISDN
 
                thresholdID - Threshold ID
 
                IDDBalance - IDD Balance
 
                billCycle - Bill Cycle
 
                planIDDAllowance - Plan IDD Allowance
 
                usedIDDBalance - Used IDD Balance
 
                excessUsageThreshold - Excess Usage Threshold
 
                TOTALALLOWANCEMIN - Total Allowance Minutes
 
 
 
Included Value International Minutes Notification
 
                {$account->id} - Account ID
 
                {$account->getShortName()} - Account Name
 
                service_identifier - Service Identifier
 
                service_id - Service Id
 
                messageID - Message ID
 
                ratePlanID - Rate Plan ID
 
                MSISDN - MSISDN
 
                thresholdID - Threshold ID
 
                IDDBalance - IDD Balance
 
                billCycle - Bill Cycle
 
                planIDDAllowance - Plan IDD Allowance
 
                usedIDDBalance - Used IDD Balance
 
                excessUsageThreshold - Excess Usage Threshold
 
                TOTALALLOWANCEMIN - Total Allowance Minutes
 
 
 
Low Inventory Event
 
                {$account->id} - Account ID
 
                {$account->getShortName()} - Account Name
 
                product_category_name - Product Category Name
 
                product_id - Product Id
 
                product_name - Product Name
 
                total_instances - Total Remaining Product Instances
 
 
 
Bulk Upload Complete
 
                import_type - Import Type Name
 
                file_name - File Name
 
                summary - Summary
 
                processing_detail - Detail
 
 
 
User Portal Enabled
 
                user_id - User Id
 
                account_id - Account Id
 
                username - Username
 
                password - Password
 
 
 
User Password Change
 
                user_id - User Id
 
                name - Name
 
                username - Username
 
                old_password_hash - Old Password Hashed
 
                new_password - New Password
 
 
 
BoltOn AddOn Prov Failed
 
                account_id - Account Id
 
                boltOnAddOnAccountName - Account Name
 
                boltOnAddOnExternalName - Bolton AddOn External Name
 
                boltOnPlanName - Bolton Plan Name
 
                boltOnServicePlanName - Bolton Service Plan Name
 
                boltOnFailedNote - Bolton Failed Note
 
 
 
BoltOn Provisioning Failed
 
                account_id - Account Id
 
                boltOnAccountName - Account Name
 
                boltOnExternalName - Bolton External Name
 
                boltOnServicePlanName - Bolton Service Plan Name
 
                boltOnFailedNote - Bolton Failed Note
 
 
 
Credit Trigger Limit Warning Notify
 
                {$account->id} - Account ID
 
                {$account->getShortName()} - Account Name
 
                auto_top_up_trigger_limit - Auto Top-up Trigger Limit
 
                account_unallocated_amt - Account Unallocated Amount
 
                pending_payment - Pending Payment Amount
 
                account_balance - Account Balance
 
                sum_usage_value - Total Usage Value
 
                sum_cardline_value - Total Cardline Value
 
                unbilled_charges - Unbilled Charges
 
                gap_of_unbilled - Gap of Unbilled Total Value
 
                unbilled_percentage_to_check - Unbilled Percentage Value
 
 
 
Credit Trigger Limit Initiate Payment
 
                {$account->id} - Account ID
 
                {$account->getShortName()} - Account Name
 
                auto_top_up_trigger_limit - Auto Top-up Trigger Limit
 
                top_up_amount_attr_value - Auto Top-up Amount Attribute Value
 
                top_up_amount_attr_value_type - Auto Top-up Amount Attribute Value Type
 
                account_unallocated_amt - Account Unallocated Amount
 
                sum_pending_payment - Pending Payment Amount
 
                payment_in_last_24_hours - Payment in last 24 hours
 
                account_balance - Account Balance
 
                gap_of_unbilled - Gap of Unbilled Total Value
 
                sum_usage_value - Total Usage Value
 
                sum_cardline_value - Total Cardline Value
 
                unbilled_charges - Unbilled Charges
 
                pay_method_enabled - Pay method Enabled
 
 
 
International Roaming Activation
 
                account_id - Account ID
 
                account_name - Account Name
 
                service_primary_identifier - Service Identifier
 
                feature_name - Feature Name
 
                instance_identifier - Instance Identifier
 
 
 
International Roaming Deactivation
 
                var template_variables_971 = [];
 
                account_id - Account ID
 
                account_name - Account Name
 
                service_primary_identifier - Service Identifier
 
                feature_name - Feature Name
 
                instance_identifier - Instance Identifier
 
 
 
Automated Payment Setup
 
                var template_variables_972 = [];
 
                account_id - Account ID
 
                account_name - Account Name
 
                payment_type - Payment Method
 
                enabled_via - Enabled Via
 
                activation_date - Activation Date
 
                terms_and_conditions - Terms And Conditions
 
                outstanding_amount - Outstanding Amount
 
 
 
BoltOn AddOn Activation
 
                account_id - Account ID
 
                account_name - Account Name
 
                data_packs - Data Packs
 
                billing_cycle_expiry - Billing Cycle End
 
                service_id - Service ID
 
                service_identifier - Service Identifier
 
                add_on_external_name - Add On External Name
 
                start_date - Start Date
 
 
 
Service BoltOn AddOn Cap Usage
 
                period_ratio - Period Ratio
 
                service_cap_base_amount - Cap Base Amount
 
                service_cap_base_amount_mb - Cap Base Amount in MB
 
                service_cap_amount - Cap Amount
 
                period_start - Usage Period Start
 
                period_end - Usage Period Finish
 
                max_type_name - Max type Name
 
                external_name - External Name
 
                current_usage - Current Usage
 
                current_usage_mb - Current Usage in MB
 
                percentage_used - Percentage Used
 
                current_usage_left - Current Usage Left
 
                current_usage_left_mb - Current Usage Left in MB
 
                sbs_id - Service Bolt On Subscription Id
 
                sbas_id - Addon Subscription ID
 
                ss_id - Service Subscription Id
 
                percentage_trigger_point - Percentage Trigger Point
 
                contact_salutation - Contact Salutation
 
                firstname - Firstname
 
                lastname - Lastname
 
                service_identifier - Service Identifier
 
                days_remaining - Days Remaining
 
                account_id - Account ID
 
 
 
Automated Payment Deactivation
 
                account_id - Account ID
 
                account_name - Account Name
 
                payment_type - Payment Method
 
                deactivation_date - Deactivation Date
 
 
 
MURTL Bolt On Threshold
 
                period_ratio - Period Ratio
 
                service_cap_base_amount - Cap Base Amount
 
                service_cap_base_amount_mb - Cap Base Amount in MB
 
                service_cap_amount - Cap Amount
 
                period_start - Usage Period Start
 
                period_end - Usage Period Finish
 
                max_type_name - Max type Name
 
                current_usage - Current Usage
 
                current_usage_mb - Current Usage in MB
 
                percentage_used - Percentage Used
 
                current_usage_left - Current Usage Left
 
                current_usage_left_mb - Current Usage Left in MB
 
                sbs_id - Service Bolt On Subscription Id
 
                ss_id - Service Subscription Id
 
                percentage_trigger_point - Percentage Trigger Point
 
                contact_salutation - Contact Salutation
 
                firstname - Firstname
 
                lastname - Lastname
 
                service_identifier - Service Identifier
 
                days_remaining - Days Remaining
 
                account_id - Account ID
 
 
 
MURTL Bolt On Add On Threshold
 
                period_ratio - Period Ratio
 
                service_cap_base_amount - Cap Base Amount
 
                service_cap_base_amount_mb - Cap Base Amount in MB
 
                service_cap_amount - Cap Amount
 
                period_start - Usage Period Start
 
                period_end - Usage Period Finish
 
                max_type_name - Max type Name
 
                external_name - External Name
 
                current_usage - Current Usage
 
                current_usage_mb - Current Usage in MB
 
                percentage_used - Percentage Used
 
                current_usage_left - Current Usage Left
 
                current_usage_left_mb - Current Usage Left in MB
 
                sbs_id - Service Bolt On Subscription Id
 
                sbas_id - Addon Subscription ID
 
                ss_id - Service Subscription Id
 
                percentage_trigger_point - Percentage Trigger Point
 
                contact_salutation - Contact Salutation
 
                firstname - Firstname
 
                lastname - Lastname
 
                service_identifier - Service Identifier
 
                days_remaining - Days Remaining
 
                account_id - Account ID
 
 
 
Payment Plan Created
 
                plan_id - Plan ID
 
                {$account->id} - Account ID
 
                parent_account_id - Parent Account ID
 
                amount - Total Payment Plan Amount
 
                start_date - Start Date
 
                o_a_b - Outstanding Account Balance
 
                method - Payment method
 
                installments - Number of Installments
 
                transactions - Transactions List
 
                billing_fname - First Name
 
                billing_lname - Last Name
 
                billing_sname - Salutation
 
                billing_name - Full Name
 
 
 
Payment Plan Cancelled
 
                plan_id - Plan ID
 
                {$account->id} - Account ID
 
                parent_account_id - Parent Account ID
 
                amount - Total Payment Plan Amount
 
                start_date - Start Date
 
                o_a_b - Outstanding Account Balance
 
                method - Payment method
 
                installments - Number of Installments
 
                transactions - Transactions List
 
                billing_fname - First Name
 
                billing_lname - Last Name
 
                billing_sname - Salutation
 
                billing_name - Full Name
 
 
 
Payment Plan Completed
 
                plan_id - Plan ID
 
                {$account->id} - Account ID
 
                parent_account_id - Parent Account ID
 
                amount - Total Payment Plan Amount
 
                start_date - Start Date
 
                o_a_b - Outstanding Account Balance
 
                method - Payment method
 
               
 
                installments - Number of Installments
 
                transactions - Transactions List
 
                billing_fname - First Name
 
                billing_lname - Last Name
 
                billing_sname - Salutation
 
                billing_name - Full Name
 
 
 
Payment Plan Transaction Failed
 
                plan_id - Plan ID
 
                {$account->id} - Account ID
 
                parent_account_id - Parent Account ID
 
                amount - Total Payment Plan Amount
 
                start_date - Start Date
 
                o_a_b - Outstanding Account Balance
 
                method - Payment method
 
                scheduled - Scheduled Payment Date
 
                d_f_pmt - Pmt Failed Date
 
                trans_amount - Payment amount
 
                installments - Number of Installments
 
                transactions - Transactions List
 
                billing_fname - First Name
 
                billing_lname - Last Name
 
                billing_sname - Salutation
 
                billing_name - Full Name
 
 
 
Shape BoltOn
 
                {$account->id} - Account ID
 
                account_name - Contact Name
 
                bolt_on_name - Plan Bolt On Name
 
                bolt_on_period_start - Plan Bolt On Period Start
 
                bolt_on_period_end - Plan Bolt On Period End
 
                service_identifier - Service Identifier
 
 
 
Unshape BoltOn
 
                {$account->id} - Account ID
 
                account_name - Contact Name
 
                bolt_on_name - Plan Bolt On Name
 
                bolt_on_period_start - Plan Bolt On Period Start
 
                bolt_on_period_end - Plan Bolt On Period End
 
                service_identifier - Service Identifier
 
 
 
Service Activated
 
                {$account->id} - Account ID
 
                contact_first_name - Contact First Name
 
                contact_last_name - Contact Last Name
 
                service_core_identifier - Service Identifier
 
                service_plan_external_name - Service Plan External Name
 
                contract_start_date - Contract Start Date
 
                contract_end_date - Contract End Date
 
                billing_cycle_date - Billing Cycle Day
 
 
 
Payment Extension Created
 
                account_id - Account ID
 
                account_name - Account Name
 
                invoice_number - Invoice Number
 
                original_due_date - Original Due Date
 
                new_due_date - New Due Date
 
 
 
Service Type Migrate Completed
 
                account_id - Account ID
 
                old_package_name - Old Package Name
 
                new_package_name - New Package Name
 
                migrate_date - Migration Date
 
                service_identifier - Service Identifier
 
                {$account->getShortName()} - Account Name
 
 
 
Notify Forced Provisioned BoltOn AddOn Failure
 
                data_packs - Data Packs
 
                billing_cycle_expiry - Billing Cycle End
 
                account_id - Account ID
 
                service_id - Service ID
 
                service_identifier - Service Identifier
 
                original_request_date - Original Request Date
 
                reason_for_failure - Reason For Failure
 
 
 
Notify Forced Provisioned BoltOn AddOn Success
 
                data_packs - Data Packs
 
                billing_cycle_expiry - Billing Cycle End
 
                service_identifier - Service Identifier
 
 
 
Notify Forced Provisioned BoltOn AddOn Delay
 
                data_packs - Data Packs
 
                billing_cycle_expiry - Billing Cycle End
 
                account_id - Account ID
 
                service_id - Service ID
 
                service_identifier - Service Identifier
 
                original_request_date - Original Request Date
 
 
 
Terms and condition email
 
                {$account->id} - Account ID
 
                account_name - Account Name
 
                package_plan_name - Package Plan Name
 
                terms_and_conditions - Terms & Conditions
 
 
 
Notify Service Referee New BoltOnAddOn
 
                referee_account_id - Referee Account ID
 
                referee_account_name - Referee Account Name
 
                referee_first_name - Referee First Name
 
                referee_last_name - Referee Last Name
 
                referee_service_identifier - Referee Service Identifier
 
                referee_service_id - Referee Service ID
 
                referee_package_plan_id - Referee Package Plan ID
 
                referee_package_plan_name - Referee Package Plan Name
 
                referee_package_contract_length - Referee Package Contract Length
 
                referee_service_activation_date - Referee Service Activation Date
 
                referee_bonus_expiry_date - Referee Bonus Expiry Date
 
                referee_bolton_addon_name - Referee Bolt-On Add-On Name
 
                referrer_account_id - Referrer Account ID
 
                referrer_account_name - Referrer Account Name
 
                referrer_first_name - Referrer First Name
 
                referrer_last_name - Referrer Last Name
 
                referrer_service_identifier - Referrer Service Identifier
 
                referrer_service_id - Referrer Service ID
 
                referrer_package_plan_id - Referrer Package Plan ID
 
                referrer_package_plan_name - Referrer Package Plan Name
 
                referrer_package_contract_length - Referrer Package Contract Length
 
                referrer_service_activation_date - Referrer Service Activation Date
 
                referrer_bonus_expiry_date - Referrer Bonus Expiry Date
 
                referrer_bolton_addon_name - Referrer Bolt-On Add-On Name
 
 
 
Notify Service Referrer New BoltOnAddOn
 
                //referee
 
                referee_account_id - Referee Account ID
 
                referee_account_name - Referee Account Name
 
                referee_first_name - Referee First Name
 
                referee_last_name - Referee Last Name
 
                referee_service_identifier - Referee Service Identifier
 
                referee_service_id - Referee Service ID
 
                referee_package_plan_id - Referee Package Plan ID
 
                referee_package_plan_name - Referee Package Plan Name
 
                referee_package_contract_length - Referee Package Contract Length
 
                referee_service_activation_date - Referee Service Activation Date
 
                referee_bonus_expiry_date - Referee Bonus Expiry Date
 
                referee_bolton_addon_name - Referee Bolt-On Add-On Name
 
                //referral
 
                referrer_account_id - Referrer Account ID
 
                referrer_account_name - Referrer Account Name
 
                referrer_first_name - Referrer First Name
 
                referrer_last_name - Referrer Last Name
 
                referrer_service_identifier - Referrer Service Identifier
 
                referrer_service_id - Referrer Service ID
 
                referrer_package_plan_id - Referrer Package Plan ID
 
                referrer_package_plan_name - Referrer Package Plan Name
 
                referrer_package_contract_length - Referrer Package Contract Length
 
                referrer_service_activation_date - Referrer Service Activation Date
 
                referrer_bonus_expiry_date - Referrer Bonus Expiry Date
 
                referrer_bolton_addon_name - Referrer Bolt-On Add-On Name
 
 
 
----
 
 
 
=See also the following=
 
* [[Events | Events]]
 
* [[SystemEvents/Actions|Event actions]]
 
* [[SystemEvents/Triggers|Event triggers]]
 
* [[SystemEvents/Templates|Templates]]
 

Latest revision as of 16:50, 2 November 2018

This Content Has Moved House

This article has been moved to our new home for documentation and help content, the new Emersion Knowledge Base.

We are sorry for the untidiness while we are shifting locations and we appreciate your patience during the transition to our new home.

Take me to the Emersion Knowledge Base article

New home sm.jpg