2,299
edits
Changes
m
The The '''Message Queue Queue'''feature setting in SmartSimple the [[Business & System Configuration|System]] section of the [[Global Settings]] page allows you to view a list of systemgenerated e-generated emails. These emails could mails that have been sent from a variety of sources within the system, including from [[Workflows]] and password activationsetc.
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[[Image:Message_queue_update. png|700px]]
==Configuration - Essentials==
===Accessing the Message Queue===
1. Click on the 9-square menu icon on the top right of your page.
:: {{Icon-Menu}}
2. Under the heading '''Configuration, '''select [[Global Settings|'''Global Settings''']].
3==Navigating to the Message Queue==# Click on the Configuration menu, then select the [[Global Settings]] option. Scroll down # Under the System Configuration section, locate and clink on the first tab to '''Message Queue''' hyperlink.# Displayed is the subheading '''System Log and Summary.Message Queue'''list view.
4. Click on the hyperlink '''Message Queue. '''
: [[File:Message queue.png|400px|border]]
Emails that have been generated from the system for a maximum of one year previous will appear in the Message Queue.
* '''Note: '''==Viewing a Message==The Message Queue may need some time to load depending on queue should contain columns including the amount of emails that will be listedEmail Body and Subject options.
===Understanding If the Message Queue===The message queue has several tabs that provide different functionscontent of the email body is too large to be fully exposed in the column then it appears with an ellipsis.
:: [[File:Message queue 1.png|800px|border]]On Clicking the ellipsis will open a light-box that exposes the topfull email, right underneath the '''Message Queue '''title, are a number including the entire contents of options to determine what types of messages you can accessthe Email body.
{| class="wikitable"
|-
||'''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.
|-==Deleting a Message==||'''Sent'''||Any To delete a message in '''Sent '''has successfully reached listed in the ''server ''of the receiver. In Queue, Sent , or Failed tabs, add a check mark all desired messages cannot be modified . Once one or deletedmore messages have been selected, the delete icon will appear. Click on the delete icon and accept the confirmation message.
'''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.
|==Re-sending a Failed Message==||'''Messages that were not successfully sent will be listed in the Failedtab. To resend a failed message, add a check mark to one or more messages, this action will activate the '''||The '''Failed Re-send'''section will list all of button. Click the systemRe-generated emails that did not go through into another serversend button and accept the confirmation message.
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.
:: [[File:Message queue searchj.png|500px|border]]
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<br />'''
* '''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 contains columns including '''Subject '''and '''Body '''options. The '''Body '''will display the content of the email; if it is too large to be fully exposed in the column, then it appears with an ellipsis.
Clicking into the ellipsis opens a modal window of the full email contents.
===Deleting a Message===
To delete a message in any of the tabs, add a check mark to the desired messages to be deleted. Once one or more of the messages have been selected, a '''trashcan icon '''will appear at the top of the list view. Clicking on this icon will open a modal window asking you to confirm your deletion, and upon acceptance, allow you to delete the selected messages.
===Re-sending a Failed Message===
Messages that were not successfully sent will be listed in the '''Failed tab. '''To resend a failed message, simply add a check mark to one or more of the messages while you are in the tab. This action will activate the '''Re-send button '''to appear. Clicking on the '''Re-send button '''and accepting the confirmation message that pops up will allow you to resend those previously failed messages.
==Configuration - Advanced==
===Enabling Permissions for the Message Queue===
To enable specific permissions for the Message Queue, you - as a [[Global User Administrator|System Administrator]] can select which roles in your copy of SmartSimple should have access and use of the Message Queue function.
1. Click on the 9-square menu icon on the top right of your page.
:: {{icon-Menu}}
2. Under the heading '''Configuration, '''select '''Global Settings.'''
3. Click onto the tab labelled '''Security. '''
4. Under the first subheading, '''Business Security, '''select the hyperlink [[System Feature Permissions|'''System Feature Permissions''']].
:: [[File:Sys feature permissions1.png|600px|bordder]]
5. Under the last tab, '''Feature Permissions, '''scroll down until you find '''Enable Message Queue. '''
:: [[File:Enable message queue.png|350px|border]]
Clicking into the text will allow you to select from a drop-down of [[User role|roles]] available in the system.
Click the '''Save '''button when you are done permissioning the Message Queue functionality.
==Overview==
===Searching the Message Queue=Notes==The '''* The Message Queue '''uses search functionality that allows you Queue may take a long time to filter load the resultslist. List load time may be affected by list size.* Messages are displayed in the Message Queue for two months.
==See Also==
