Message Queue

From SmartWiki
Revision as of 13:01, 18 June 2019 by Emmy Fu (talk | contribs) (Searching the Message Queue)

Jump to: navigation, search

Overview

The Message Queue feature in SmartSimple allows you to view a list of system-generated emails. These emails could have been sent from a variety of sources within the system, including from Workflows and password activations. 

The Message Queue is particularly useful for ensuring that emails have properly been sent, for record-keeping, and for allowing you some leeway to delete messages should they have been sent in error. 

Configuration - Essentials

Accessing the Message Queue

1. Click on the 9-square menu icon on the top right of your page.

052919 MenuIcon.png 

2. Under the heading Configuration, select Global Settings

3. Scroll down on the first tab to the subheading System Log and Summary.

4. Click on the hyperlink Message Queue. 

Message queue.png

Emails that have been generated from the system for a maximum of one year previous will appear in the Message Queue. 

Understanding the Message Queue

The message queue has several tabs that provide different functions.

Message queue 1.png

On the top, right underneath the Message Queue title, are a number of options to determine what types of messages you can access. 

In Queue

Any message that is in the queue means that though it has left our SmartSimple server, it has not yet reached the inbox of the receiver. Although this limbo time is variable, it usually approximates 5 minutes or so. Messages in the queue can be deleted to ensure that they won't reach the receiver; a use case would be for a message that has been sent in error, such as an "Application Accepted" message. 

Note: Although the Message Queue is useful for this function, it is not best practice to rely on the Message Queue to void your mistakes. Be careful with activating or sending system-generated emails to ensure that wrongful notifications are not sent to users.

Sent

Any message in Sent has successfully reached the server of the receiver. Sent messages cannot be modified or deleted. 

Note: The Sent list cannot confirm that it has necessarily reached an inbox, but it can confirm that it has been sent to the server.

The Sent area is a good section to check if you have a complaint about not receiving emails properly; the Sent list can confirm that an email was indeed sent, and in that case, the receiver should be directed to check the Spam mail in their inbox or the double-check their incoming mail. 

Failed

The Failed section will list all of the system-generated emails that did not go through into another server.

The primary reasons for failed messages include an incorrectly typed email address, or an absentee email address. 

Archived The Archived section lists all emails that were sent over a year ago from the time that you check. 

Tip: Best practice is to check the Message Queue at least every 6 months or a year. You can ensure that emails are being properly sent out and upkeep records of email lists that IT or auditing departments may require. 

Searching the Message Queue

The Message Queue uses search functionality that allows you to filter the results.

Message queue searchj.png

The search bar will appear on the top right above the list of messages regardless of which tab you are in. 

You can search selectively by the available Standard Fields displayed in the Message Queue list view: 

  • From
  • CC
  • To
  • Subject
  • Created
  • Action

The default is to Search All Columns. 

Note: Remember to clear your search when you begin or if the results are not appearing as you expected - our system is sticky, meaning that the search filters from your previous session will save when you log in again. 

You can also toggle Sort Order by clicking on the label of each column. It will allow you to sort the results by ascending or descending order, 

Viewing a Message

The Message queue should contain columns including the Email Body and Subject options.

If the content of the email body is too large to be fully exposed in the column then it appears with an ellipsis.

Clicking the ellipsis will open a light-box that exposes the full email, including the entire contents of the Email body.


Deleting a Message

To delete a message listed in the the In Queue, Sent, or Failed tabs, add a check mark all desired messages. Once one or more messages have been selected, the delete icon will appear. Click on the delete icon and accept the confirmation message.


Re-sending a Failed Message

Messages that were not successfully sent will be listed in the Failed tab. To resend a failed message, add a check mark to one or more messages, this action will activate the Re-send button. Click the Re-send button and accept the confirmation message.


Notes

  • The Message Queue may take a long time to load the list. List load time may be affected by list size.
  • Messages are displayed in the Message Queue for two months.


See Also