Messenger Service

Messenger Service
Version 4.4
accesso
302 Camino de la Placita
Taos, NM 87571
575.751.0633
www.accesso.com
Copyright
Copyright 2015 accesso Technology Group, plc. All rights reserved.
NOTICE: All information contained herein is the property of accesso Technology Group, plc. No part of this
publication (whether in hardcopy or electronic form) may be reproduced or transmitted, in any form or by any
means, electronic, mechanical, photocopying, recording, or otherwise, without the prior written consent of
accesso Technology Group, plc. The software, which includes information contained in any databases,
described in this document is furnished under a license agreement and may be used or copied only in
accordance with the terms of that agreement.
This publication and the information herein is furnished AS IS, is subject to change without notice, and should
not be construed as a commitment by accesso Technology Group, plc. accesso Technology Group, plc. assumes
no responsibility or liability for any errors or inaccuracies, makes no warranty of any kind (express, implied, or
statutory) with respect to this publication, and expressly disclaims any and all warranties of merchantability,
fitness for particular purposes, and non-infringement of third party rights.
Introduction .......................................................................................................................................................................... 2
SiriusSQL database ............................................................................................................................................................ 2
New tables: ......................................................................................................................................................................................................3
New functions: ................................................................................................................................................................................................3
New stored procedures: ...............................................................................................................................................................................3
Installation ............................................................................................................................................................................ 4
The Messenger Service installer: ....................................................................................................................................... 4
Messenger Service and email ................................................................................................................................................ 9
E-Commerce emails ........................................................................................................................................................... 9
Setup and Configuration information.................................................................................................................................. 10
.INI Settings ..................................................................................................................................................................... 10
Pod booking emails ............................................................................................................................................................. 11
Editing email addresses ....................................................................................................................................................... 11
Troubleshooting .................................................................................................................................................................. 12
Introduction
Messenger Service application is responsible for generating automated messages to pre-established email
recipients. This application handles email being sent from the Sales Host and pod booking emails. Also, Messenger
Service creates an alert system that works in conjunction with the Kiosk module and Cash Management
functionality. This service also monitors conditions such as duplicates and SQL errors of Kiosk, Cash Management
and basic Sales functionality.
The Messenger Service application allows for the following notifications to be sent to designated email recipients
i.e., technical support or management staff:
1. Kiosk notifications
• Bill collector malfunctions
• Issues with Printer
• Customer Needs (Call For Help button)
• Maintenance notifications
• Emails that kiosks have been serviced
2.
3.
4.
5.
Cash Management notifications
Cash threshold is met
Drawer skim occurs
Duplicates and SQL errors
The service consists of four parts implemented as classes MsgService, MessageDB, MsgProcessor and the
SvcMonitor. There is also MsgHandler derived classes to handle sending emails/SMS/etc., owned by the
MsgProcessor class, as well as a message class and two queues of messages used by the components.
•
•
•
•
MsgService is the program that instantiates the other main components and queues and connects the
MessageDB and MsgProcessor to the queues.
MessageDB connects to the database using stored procedures
MsgProcessor sends message using a MsgHandler derived class.
SvcMonitor sends HTML formatted status info to the Service Monitor app and can receive commands
from the user.
SiriusSQL database
The following tables, functions and procedures now exist in the SiriusSQL database in support of the application
called Messenger Service:
New tables:
MessengerAttachments, MessengerStatus, MessengerStatusName and MessengerMessages
New functions:
siriusfn_msgr_ConvertStatusIntToName
siriusfn_msgr_ConvertStatusNameToInt
New stored procedures:
Siriussp_msgr_CreateAttachment
Siriussp_msgr_GetAttachment
Siriussp_msgr_SelectPendingMessages
Siriussp_msgr_UpdateStatusCounts
siriussp_msgr_GetStatusCounts
siriussp_msgr_GetMessageStatus
siriussp_msgr_SelectMessages
siriussp_msgr_SubmitMessage
siriussp_msgr_StartRetries
siriussp_msgr_UpdateMessageStatus
siriussp_msgr_SelectPendingMessages
The following stored procedures are available to the user of the SiriusMSAPI:
siriussp_msgr_SubmitMessage
•
SubmitMessage creates a unique id for the message and return it to the caller.
siriussp_msgr_GetMessageStatus
•
GetMessageStatus returns the numeric value for the message’s current status.
siriussp_msgr_CreateAttachment
•
CreateAttachment is called BEFORE SubmitMessage. The ID returned must be passed to
SubmitMessage if an attachment is to be included with a message.
Installation
The Messenger Service application should be installed on your Middleware server (Pool Server). The Messenger
Service application allows for messages to be sent via email from POS computers and kiosks on the network to
back office and management computers.
The Messenger Service installer:
•
•
Creates the ProgramData\Siriusware\MessengerService and Program
Files\Siriusware\MessengerService directories and associated files.
Installs a desktop shortcut to Messenger Service and Update Messenger Service
To run the Messenger Service installer:
1. Run the Install_Siriusware_Sales_44xx.msi installer directly from the
Siriusware\Install directory.
2. You are presented with the following dialog. Click Next.
3. The following dialog appears. Click Next.
4. Next, you receive the following dialog. Enter the name or IP address of the Microsoft SQL Server that
contains the accesso Siriusware database (SiriusSQL) and the name of the accesso Siriusware database on
your server. If you are installing this on the SQL Server use [local] for the SQL Server Name. Click Next.
5. Find out your SMTP and/or IMAP/POP settings for outgoing and ingoing mail
6. If using an SMTP (Simple Mail Transfer Protocol) server for outgoing and/or incoming mail, enter the
following information:
• SMTP Server (i.e., mail.siriusware.com)
•
•
•
If your SMTP Server requires a User and Password enter this now, if not leave this blank.
Enter the Port number (The default Port is 25)
Click Use or Do Not Use SSL whichever is applicable to your site.
Note: If your email server is a POP3, do not enter information at this time simply click Next. You are then
prompted for POP3 information.
7. If using an POP3 (Simple Mail Transfer Protocol) server for outgoing and/or incoming mail, enter the
following information:
• POP3 Server (i.e., mail.siriusware.com)
• If your POP3 Server requires a User and Password enter this now, if not leave this blank.
• Enter the Port number (The default Port is 25)
• Click Use or Do Not Use SSL whichever is applicable to your site.
Note: If your email server is a SMTP only, do not enter information at this time simply click Next.
8. Click Next on the following dialog.
9. Messenger Service application begins installation.
10. When the Messenger Service installation completes, you are presented with the following dialog. Click
Finish.
11. Be sure that the latest Messenger Service update c_MessengerService_44xx.xxxx.exe is
located in the C:\Siriusware\Updates folder
12. Double Click the Update Messenger Service Icon on the desktop which pulls in the most recent version of
Messenger Service application.
13. Double Click on the Messenger Service Icon. Press Start if it is not already running.
Messenger Service and email
E-Commerce emails
This feature allows the ability to use an external SMTP server (e.g., Google’s Gmail) instead of installing and
supporting an internal SMTP server. SMTP email uses the Messenger Service application. This service provides TLS
encryption required by cloud based exchange servers along with the ability to configure the IP address and port
for the external server. The SMTP email that is driven through the Messenger Service application includes:
•
•
•
•
E-Commerce Sales Host utility based emails
Emails when booking levels reach the specified thresholds (SysManager > Preferences > Pod Bookings)
The existing Notifications functionality based on salespoint activities (SysManager > Activities > System
Lists > Configure Notifications)
Mobile Sales module receipts
Setup and Configuration information
.INI Settings
Messenger Service application has been modified to use an .INI file for its configuration settings instead of the
config file. It will still fall back to the config file if the .INI file doesn't exist, but the .INI file is now the
preferred method for handling the configuration settings. The .INI file should be in the Messenger Service
executable directory (typically, C:\Program Files (x86)\Siriusware\MessengerService) and
should be named MessengerService_system.ini. Here is an example of the settings that should be in
this .INI file:
[LogSettings]
LogFile=c:\ProgramData\Siriusware\MessengerService\MessengerService_log.txt
Level=6
[EmailSettings ]
SMTP_server=smtp.gmail.com
[email protected]
SMTP_pswd=*~*a+/B8LY3jI8bKeW5suliig==
SMTP_port=587
SMTP_useSSL=true
POP_server=pop.gmail.com
[email protected]
POP_pswd=*~*a+/B8LY3jI8bKeW5suliig==
POP_port=995
POP_useSSL=true
[email protected]
[DatabaseSettings]
Server=192.168.1.80
;ConnectString=user id=sirius; password=sirius; server=192.168.1.80;
database=SiriusSQL
ConnectString=*~*GG/eYuOam/fFOVjgLaTEam0tJu2uoekrFQq8LMbjk7jIv+LCc3G9u40KOd7N
jDLV78E
DPeQsuO74R9jBMREfgf3Kyk5nS6spF+UhWpLhqoE=
AttachmentsDirectory=C:\ProgramData\Siriusware\MessengerService\Attachments
[SvcMonitorSettings]
Port=14250
HtmlDir=C:\Program Files (x86)\Siriusware\MessengerService\HTML
Also, there is a new Send Test Email button that becomes visible when the user clicks the Show Log button in
Messenger Service. When clicked, this sends a test email from Messenger Service to the email address designated
with the [EmailSetttings] TestEmailAddress= setting from the .INI file.
Finally, Messenger Service tries to start even though there was an error during startup in an attempt to display
the error in the Service Monitor dialog.
Example:
If the ConnectString was pointing to the wrong IP address, it will display a connection error message in the
Service Monitor window.
Pod booking emails
Messenger Service application handles the sending of 80% capacity and 100% full email alerts for pod bookings.
Instead of BookEZ application being configured via ConfigManager utility to send these email alerts directly via
SMTP or MAPI, BookEZ application now submits the email alerts to the SiriusSQL database where they are picked
up by Messenger Service application and sent to the designated email server.
Editing email addresses
An enhancement to Messenger Service application allows clients to edit the email address when an email returns
an invalid email address. This is accomplished by clicking the View Send Errors button in the Messenger Service
interface. The Recipient Email Address is displayed in an editable text box. Once the email address is corrected,
the user needs to click the Retry button followed by the Process Retries button. Messenger Service application
then attempts to send the email to the new email address.
Notes on using this feature: If Messenger Service application is busy processing lots of requests, this is not the
ideal time to change email addresses and resubmit them. The interface resets every ten seconds, so unless you
can enter a new email address, click the Retry button followed by clicking the Process Retries button all in ten
seconds or less, the email address is reset to the one originally stored in the data. For this reason it is better to
attempt these email address corrections and resends when things are slow.
Also, due to this change, the interface is a little less responsive than it used to be. So you may notice a longer
delay when the buttons are clicked for Viewing and Hiding the Send Errors and for the Process Retries button to
display after selecting one or more emails to retry.
Troubleshooting
In order to discover details if issues arise with Messenger Service application:
1. From a command prompt, navigate to the C:\Program Files
(x86)\Siriusware\MessengerService folder (or wherever the messengerservice.exe
program is located) by typing: cmd C:\Program Files
(x86)\Siriusware\MessengerService
2. Hit Enter
3. Next, run the messengerservice.exe with a debug parameter by typing the following line:
messengerservice.exe /debug
4. Hit Enter
5. A message outlining any issues with Messenger Service application displays.