Miracle Service Accent SMS and Email Notifications Setup And User Guide June 2004
Legal Information All rights reserved. No part of this document shall be reproduced or transmitted by any means or otherwise, without written permission from Vantage Computing Limited. This document is provided as is and all express or implied conditions, representations, and warranties, including any implied warranty of merchantability, fitness for a particular purpose, or noninfringement, are disclaimed, except to the extent that such disclaimers are held to be legally invalid. Trademarks Miracle Service Accent is a Joint Trademark of Vantage Computing Limited and Nextair Corporation. All product names mentioned in this documentation are the trademarks of their respective owners. This document also includes the trademarks, trade names, and service marks of companies other than Vantage Computing Limited. The product described in this document is distributed under license, restricting its use, copying, distribution, and decompilation. No part of the product or this documentation may be reproduced in any form by any means without prior written authorisation of Vantage Computing Limited.
contents 1 Introduction Overview of notifications...2 About this Guide...3 Documentation Conventions...4 Contacting Your Support Provider...5 contents 2 How to set up your SMS account Your SMS Balance...7 Messaging costs...8 Purchasing Credit...8 3 Setting up SMS and email notifications in MSA Enabling notifications...12 Configuring email messages...15 Configuring SMS messages...16 Using SMS and email notifications in MSA...18 Document Version 3.0 MSA SMS and email notifications setup and user guide i
contents contents
chapter 1 Introduction Welcome to the Miracle Service Accent SMS and Email Notifications Setup and User guide. This chapter contains the following topics: Overview of notifications About this Guide Documentation Conventions Contacting Your Support Provider Document version 3.0 MSA SMS and email notifications setup and user guide 1
Introduction Overview of notifications The SMS and Email notifications module is a software solution that is designed to work as part of Miracle Service Accent. It allows SMS and email messages to be sent to your engineers, customers or named individuals, based on certain triggers. When an outgoing message is generated from Miracle Service Accent, the message is either sent by email or by the internet to Clickatell (if SMS notifications are selected) and this is then distributed to the destination specified in the original message. To enable you with SMS messaging, Vantage Computing International (VCI) has teamed up with Clickatell, a company that specialises in SMS technology. An account will be set up in your name which enables you to have complete control over your messaging costs. Every message that you send through the Clickatell network will incur a charge which is deducted from your account. Please note that although you have your own account, you will not be able to alter its configuration, which has been set by VCI. Vantage Computing Ltd cannot control or guarantee the accuracy of any information on the Clickatell web site. Vantage Computing Ltd cannot be held liable for damages resulting from the use of, the lack of availability of, or problems with, Clickatell or its services. 2 MSA SMS and email notifications setup and user guide Document version 3.0
About this Guide About this Guide This guide consists of the following chapters: Chapter 1: Introduction an overview of SMS and Email notifications, documentation conventions, and Vantage Computing contact information. Chapter 2: How to set up your SMS account - details on how to set up SMS message notifications from Miracle Service Accent, Document version 3.0 MSA SMS and email notifications setup and user guide 3
Introduction Documentation Conventions The following icons highlight particular sections. Caution failure to observe the caution described in this section may prevent SMS notifications from operating properly. Note sections highlighted with this icon contain pertinent information, such as exceptions to the preceding steps or sections. Hint sections highlighted with this icon contain hints or suggestions. 4 MSA SMS and email notifications setup and user guide Document version 3.0
Contacting Your Support Provider Contacting Your Support Provider Web site:www.miracleserviceaccent.com, click on support Telephone and Email details will be provided by your support provider. Document version 3.0 MSA SMS and email notifications setup and user guide 5
Introduction 6 MSA SMS and email notifications setup and user guide Document version 3.0
chapter 2 How to set up your SMS account Before you start sending SMS messages, Your support provider needs to create a new account with Clickatell. Your account will be set up and details will be sent to you. Your SMS Balance It is your responsibility to ensure you have enough credit in your SMS account. If you do not have any credit you will not be able to send SMS messages. Your account details will have been sent to you already, but you need to ensure that it has sufficient balance at all times to ensure you can send SMS messages. When you log in for the first time, you may notice that you have a positive balance; credits are normally added to allow the service to be tested prior to delivery. Any remaining balance can be used by yourself To log in to your account, go to: http://www.clickatell.com/central/login.php Enter your Username, ClientID and password and a screen similar to the following will be displayed; Document version 3.0 MSA SMS and email notifications setup and user guide 7
How to set up your SMS account Click on the word Balance and the following will be displayed; Your account will be set up so that you receive email notifications automatically when your balance falls below a pre-determined threshold. Your current threshold and notification email address(es) will be displayed which can be amended if necessary The total number of credits left on your account is displayed at the top of the screen. Enter either a mobile phone number or email address to have the alert sent to, in the boxes indicated. Click Exit to exit the balance screen. Messaging costs You can determine the costs of an SMS message by going to: http://www.clickatell.com/brochure/coverage.php For example, the cost of sending an SMS to a UK number is 1.5 credits. If the cost per credit is 0.029 then each SMS will cost just over 4p to send. Simply work out how many SMS messages you are likely to send and enter the number. If you have 10 engineers and you expect to send 5 messages a day to each of them, you will need approximately 1,500 credits a month; this is the figure you need to enter when purchasing credits. Purchasing Credit Credits do not expire, so there is no harm in purchasing too many; additionally, credits purchased appear in your account straight away. However, the first time you purchase credits your card may need to be authorised. You should download the form from the purchasing site and submit it prior to your initial purchase, or go to: http://www.clickatell.com/downloads/creditcard_form.pdf 8 MSA SMS and email notifications setup and user guide Document version 3.0
Purchasing Credit To purchase credits go to www.clickatell.com and enter your Username, ClientID and password and a screen similar to the following will be displayed; Click on the words Purchase Credits and the following will be displayed; Document version 3.0 MSA SMS and email notifications setup and user guide 9
How to set up your SMS account The easiest and quickest method is to purchase via credit card. Simply enter the number of messages you wish to purchase, fill in your credit card details and click Purchase (see below). 10 MSA SMS and email notifications setup and user guide Document version 3.0
chapter 3 Setting up SMS and email notifications in MSA Firstly, you need to have purchased and activated the MSA SMS and email notifications module. To check that you have this, in Miracle Service Accent, click on System and then License Details. The following screen will be displayed; Document version 3.0 MSA SMS and email notifications setup and user guide 11
Setting up SMS and email notifications in MSA Click Next and details of your licensed modules will be displayed. If SMS and email notifications has a red tick against it you have purchased and activated the notifications module. If SMS and email notifications is greyed out, you need to contact your support provider to purchase and/or activate the module. Enabling notifications Click Admin, in Miracle Service Accent window s button bar, click Settings and click System Settings. 12 MSA SMS and email notifications setup and user guide Document version 3.0
Enabling notifications The following screen is displayed; Click Work control on the left and the following will be displayed; The comms tab is not activated unless the SMS and email notifications module has been activated. Document version 3.0 MSA SMS and email notifications setup and user guide 13
Setting up SMS and email notifications in MSA Click on the Comms tab and the following screen is displayed; Click Enable automatic notifications to enable automatic notifications and then click on Configure notifications and the following screen will be displayed; 1. In the Notify engineer and/or Notify customer, select when the notification is triggered from the drop-down list. The default is Job is logged. 14 MSA SMS and email notifications setup and user guide Document version 3.0
Configuring email messages Configuring email messages 1. To set up a standard e-mail notification for Engineers or customers, click Configure e-mail. The E-mail and SMS Configuration screen appears; 2. In the Subject field, enter a meaningful subject for the email. 3. In the Available fields list, highlight the MSA fields that you want to appear in the e-mail, and then click the arrow key to move them to the Message field. To remove a field from Message, highlight and delete it as you would any text. You can add text to the message, such as titles for the fields you select. 4. Enable URL encode field to activate the ability to put a URL (or hyperlink) in the message area. 5. In the Footer area, enter any footers that are required on the email. When completed, an e-mail message appears similar to the following. Document version 3.0 MSA SMS and email notifications setup and user guide 15
Setting up SMS and email notifications in MSA 6. Click Save and Close to save the message or click Delete and close to delete the message. You are returned to the Notifications settings dialogue. Configuring SMS messages 1. To set up a standard SMS notification for Engineers or customers, click Configure SMS. The E-mail and SMS Configuration screen appears; 2. In the Available fields list, highlight the MSA fields that you want to appear in the SMS message, and then click the arrow key to move them to the Message field. Remember, if you insert a field, its actual size will depend on the data that is pasted in when the message is sent. Keep your messages short. To remove a field from Message, highlight and delete it as you would any text. You can add text to the message, such as titles for the fields you select. 3. Enable URL encode field to activate the ability to put a URL (or hyperlink) in the message area. 4. In the User name, Password and API ID fields, enter a valid user ID, password and API ID as advised by your support providerl. 5. You can choose whether to send your SMS message to Clickatel via the internet (Send message via the Internet) or via email (Send message via email). The internet method is quicker and your message is delivered directly to Clickatel. If your workstation does not have a connection to the internet, the email method is available. The SMS configuration details you enter here are stored and used for all your SMS notifications. Most service providers have a limit of 160 characters for text messages. Please bear this in mind when creating SMS messages. 16 MSA SMS and email notifications setup and user guide Document version 3.0
Configuring SMS messages When completed, an SMS message appears similar to the following 6. Click Save and Close to save the message or click Delete and close to delete the message. You are returned to the Notifications settings dialogue. As well as notifying engineers or customers, you can also Notify specific people. It is the same procedure as mentioned earlier for configuring email or SMS, except that you have to add the recipients phone number or email address. Click on Add and the following dialogue is displayed: Enter the email address or phone number of the recipient. An example of a completed screen is shown 1. Enable Always display the send message dialogue when sending emails to have MSA display a message when sending emails to engineers or customers. You must tick this if you are using MS Outlook to send your messages to due to security restrictions in Outlook that will delay your message. If you have configured an outgoing SMTP server, you can leave this unticked. Document version 3.0 MSA SMS and email notifications setup and user guide 17
Setting up SMS and email notifications in MSA Click Save & close to save the notifications settings and return to the Comms subtab. Once the Enable automatic notifications has been enabled, you can configure the notifications by clicking on Admin then Settings and then Setup notifications. This is the same as configuring the notifications through system settings. Using SMS and email notifications in MSA Once you have configured SMS and email notifications, you can start using notifications from Miracle Service Accent. Depending on the triggers setup, various pop boxes will appear when completing certain tasks within Miracle Service Accent indicating that an email or SMS notification has been sent to the nominated person. 18 MSA SMS and email notifications setup and user guide Document version 3.0