Editing SystemEvents/Troubleshooting

From Emersion
Revision as of 16:14, 14 February 2017 by Dcowan (talk) (Added System Event Mapping Report Links)
Jump to: navigation, search

If a customer reports an issue or a problem with an event, there are a few ways you can troubleshoot the issue in order to resolve it.

Event Variables / Thresholds

You may utilise the System Event Mapping Report to determine your configured System Event Mappings and their associated thresholds. This report will also advise if the event mappings have enabled or disabled (or simply not created) "action mappings" as well as how many message and/or sms templates may exist.

Processed vs Unprocessed Events

It is first important to understand the difference between an event that has been processed and one that has been created but not yet processed. There are a few reasons Emersion queue events and delay processing them. Examples include:

  • SMSs to be sent only during 'safe' times. For example, not during the middle of the night.
  • When an event sends a message to a service number it may also be configured to send a message to the primary contact of the account. If these are the same, Emersion's events system will create two events, but only send one. In this instance, two events are noted, only one is processed.

By default, Emersion will not send SMS events between 8:00pm - 9:00am 7 days a week. This can be altered for a given Service Provider if different times are preferred.

Where Events can be seen in Cumulus

There are three areas in Cumulus you may want to check when troubleshooting events.

Customer Notes

In the Customer > Notes tab you can see a list of all Events that have been performed against the customer. You will also see events that were created but were failed to be sent for that customer along with any associated error messages.

Events-CustomerNotesSection.png

Click View to see further details. Click Edit to edit or add further details to the Event note.

This requires the event to have Extended Logging enabled. See below how to enable Extended Logging for an event.

Events Message Queues

Navigate: Events > Message Queue

There are two message queues in Cumulus, one each for email and SMS events respectively. The queues show both Events that have processed and unprocessed. Processed events have been sent by the system. Unprocessed events have been created by the system but have not yet been sent.

The Message Queues show you all events across your entire customer base. Use the filters at the top of the screen to refine your list and find the events you are looking for.

Message Queue filters

On the Message queue, filter the results by:

  • Account ID - Returns events for an account
  • Account name - Returns events for an account
  • Event type - Returns events for a given type of event
  • Creation date - Returns events from the Creation date to the last date an event was processed
  • Account profile name - Returns events for accounts attached to a given account profile
  • Processed flag - Returns messages created by the system and are waiting to be sent (Processed = No) or created and have been sent by the system (Unprocessed = Yes).

Events-MessageQueueEmail.png

Note: You must have SMS Events enabled by Emersion in order to use the SMS event functionality. This is not enabled by default since access fees and a charge per SMS applies. If you wish to enquire about the SMS events functionality, please contact Emersion Sales at sales@emersion.com.au

Event Reports

Navigate: Reports > Finance

There are two reports that can assist you regarding Events. These contain similar, but slightly different information on the event.

  • Events email sending log
  • Events SMS sending log

Message Queue filters

On the Message queue, filter the results by:

  • Account name/ID - Returns events for an account
  • Message phrase - Returns events with a specific word or word(s) in the subject, the sender or in the message content. This filter functions as a keyword search
  • From and To dates - Returns events processed between a given date range
  • Message sent flag - Returns messages created by the system and is waiting to be sent (Sent = No) or created and have been sent by the system (Sent = Yes)

Events-Reports.png


Why do I Need These Tools?

We provide numerous ways for you to assist troubleshoot with your client the following types of issues:

  • Ascertain whether an Emails and SMSs was sent by Emersion - can be sent (processed), not yet sent (scheduled), was not sent (no record).
  • Emails and SMSs received from clients containing information that is inaccurate or incorrect - Verify what the message contained for an event that was sent on a given date.
  • Why an SMS or email wasn't received - Emersion has no control over messages once they leave Emersion's system. Emersion cannot guarantee delivery of an email or SMS.

Other Things to Check

Here are some basic checking that should always occur when a customer reports problems with an event.

1. Are the customer's details still correct?

Check the email address or phone number you have recorded against the customer, and the service particularly if the event is a service-based event.

2. Is the event sending the SMS or email to a different delivery address or number than the customer was expecting it to go to?

Some events can send SMSs to the email address or a number associated with the service while other events can only send messages to the primary contact of the Account. In most cases, Emersion allows you to choose from a list of options. Check the Event configuration to see how the event was set up by your Administrators.

3. Is the event Enabled?

Check the Event's configuration & settings.

Enabling Extended Logging

To enable the Extended Logging function for events, you will need to alter the Event configuration. You will need to do this for each event where Extended Logging is required. Please note that not all events utilise Extended Logging, and most of the logging that occurs can be seen in the Customer > Notes tab.

Navigate: Events > Template > Mappings - This will open the Event Action Mapping List.

Find the event you wish to enable Extended Event logging for

Under the Actions column, click Edit

Events-extended-logging.png

On the Edit Event Action Mapping screen, change the Extended Event Logging setting to Enabled.

Save your changes.

Seeking Further Help

If after using the above resources, you are unable to resolve the problem, you can log a support ticket with Emersion so we can assist you further. When logging a potential fault with Emersion regarding events, please include:

  • Relevant customer IDs
  • Relevant Events and Event type(s)
  • Relevant dates & times around the event
  • What your expectations were/are
  • What actually happened. What did you actually observe.
  • From what the customer reported to you (if relevant), what were you able to verify yourself in cumulus in the Event message queue or Event sending log report?
  • The steps to reproduce the issue (if possible)
  • If the event issue is regarding a template or configuration, please include the Event type and Event Template IDs you are having trouble with.

Include all investigations you have undertaken to try to resolve the issue with the customer yourself. Please be aware that if you have not taken any steps at all to troubleshoot the issue yourself, we will simply return the ticket to you with a link to this article.