v7 User Guide.doc
Upcoming SlideShare
Loading in...5
×
 

Like this? Share it with your network

Share

v7 User Guide.doc

on

  • 1,541 views

 

Statistics

Views

Total Views
1,541
Views on SlideShare
1,541
Embed Views
0

Actions

Likes
0
Downloads
10
Comments
0

0 Embeds 0

No embeds

Accessibility

Categories

Upload Details

Uploaded via as Microsoft Word

Usage Rights

© All Rights Reserved

Report content

Flagged as inappropriate Flag as inappropriate
Flag as inappropriate

Select your reason for flagging this presentation as inappropriate.

Cancel
  • Full Name Full Name Comment goes here.
    Are you sure you want to
    Your message goes here
    Processing…
Post Comment
Edit your comment

v7 User Guide.doc Document Transcript

  • 1. 1
  • 2. TMS V7 APPLICATION SUITE MANUAL Information in this document is subject to change without notice. Companies, names and data used in examples herein are fictitious unless otherwise noted COPYRIGHT Avanquest UK Ltd. All rights reserved. No part of this publication may be reproduced, transmitted, transcribed, stored in a retrieval system, or translated into any language in any form by any means without the written permission of Avanquest UK Ltd. TRADEMARKS Captaris and RightFax are trademarks of Open Text Corporation. All other company names, brand names, and product names are the property and/or trademarks of their respective companies. 2
  • 3. Contents TMS v7 Application Suite Manual....................................................................................2 1 Introduction...........................................................................................................8 1.1 Feature Review................................................................................................................8 1.1.1 Connectivity...............................................................................................................8 1.1.2 Email Integration........................................................................................................8 1.1.3 TMS Client...............................................................................................................10 1.1.4 Reporting..................................................................................................................12 1.1.5 Customer Integration................................................................................................12 1.2 TMS Architecture Overview........................................................................................14 2 Installation Procedures........................................................................................17 2.1 TMS Server Installation...............................................................................................17 2.1.1 Minimum System Requirements..............................................................................17 2.1.2 Welcome Screen......................................................................................................18 2.1.3 System Backup Message..........................................................................................18 2.1.4 Collect User Information.........................................................................................20 2.1.5 Additional Setup Information..................................................................................21 2.1.6 Install Type..............................................................................................................22 2.1.7 TMS Server Database Type.....................................................................................23 2.1.8 TMS Server Installation Folder................................................................................25 2.1.9 TMS Shortcut Folder...............................................................................................26 2.1.10 TMS Database Folder/SQL Server Name..............................................................27 2.1.11 TMS Audit Folder..................................................................................................27 2.1.12 TMS Backup Folder Settings.................................................................................28 2.1.13 TMS File Processor Settings..................................................................................29 2.1.14 TMS GSM Settings................................................................................................30 2.1.15 TMS IP Configuration...........................................................................................31 2.1.16 TMS Email Gateway Configuration......................................................................32 2.1.17 TMS Printer............................................................................................................33 2.1.18 TMS Installing Files...............................................................................................35 2.1.19 TMS Upgrade.........................................................................................................39 2.1.20 TMS Reboot...........................................................................................................42 2.2 TMS Printer...................................................................................................................43 2.2.1 Minimum System Requirements..............................................................................43 2.2.2 Welcome Screen......................................................................................................43 2.2.3 TMS Printer Install Folder.......................................................................................44 2.2.4 TMS Printer Shortcut Folder....................................................................................45 2.2.5 TMS Printer Ready to Install...................................................................................46 2.2.6 Redirection Port Monitor.........................................................................................46 2.2.7 TMS Printer Installed Successfully..........................................................................48 3 TMS Client..........................................................................................................49 3.1.1 Minimum System Requirements..............................................................................49 3.1.2 TMS Client Installation............................................................................................49 3
  • 4. 3.1.3 Welcome Screen......................................................................................................49 3.1.4 TMS Client User Information..................................................................................50 3.1.5 TMS Client Install Folder........................................................................................51 3.1.6 TMS Client Shortcut Folder.....................................................................................52 3.1.7 TMS Server Name ..................................................................................................53 3.1.8 TMS Client Ready to Install....................................................................................54 3.1.9 TMS Installation Progress........................................................................................55 3.1.10 TMS Finish Successfully.......................................................................................56 3.2 TMS Outlook Client......................................................................................................57 3.2.1 Minimum System Requirements..............................................................................57 3.2.2 TMS Outlook Welcome Screen...............................................................................57 3.2.3 TMS Outlook Plugin User Information...................................................................58 3.2.4 TMS Outlook Plugin Installation Folder.................................................................59 3.2.5 TMS Outlook Plugin Install Information.................................................................60 3.2.6 TMS Outlook Plugin File Installation Progress.......................................................61 3.2.7 TMS Outlook Plug-in Finished Successfully...........................................................62 4 TMS Software Configuration..............................................................................63 4.1 Services...........................................................................................................................63 4.2 DCOM Server................................................................................................................64 4.3 Control Panel Applet....................................................................................................65 4.4 TMS Service Management...........................................................................................66 4.5 TMS Licence Manager.................................................................................................68 4.6 TMS Server....................................................................................................................69 4.6.1 Main Settings...........................................................................................................70 4.7 TMS EMail Gateway....................................................................................................79 4.7.1 SMTP Domain Name...............................................................................................79 4.7.2 SMTP Pickup Directory...........................................................................................79 4.7.3 Poll Period (Secs).....................................................................................................79 4.7.4 Maximum Message Size..........................................................................................79 4.7.5 Exclude email body from SMS text.........................................................................80 4.7.6 Receive email notification when SMS Sent.............................................................80 4.7.7 Receive email notification when SMS delivered by SMC......................................80 4.7.8 Restrict sending of SMS to registered users............................................................80 4.7.9 Force use of TMS Mail Libraries (Tech Support use only).....................................80 4.7.10 Auto Create Email User Accounts.........................................................................80 4.7.11 Authenticate Email Accounts via Active Directory...............................................80 4.7.12 Remove disclaimer from email body.....................................................................81 4.7.13 Save Configuration................................................................................................81 4.8 TMS File Processor.......................................................................................................82 4.8.1 Outbound Configuration..........................................................................................82 4.8.2 Inbound (Drop) Configuration.................................................................................83 4.8.3 General.....................................................................................................................83 4.8.4 Save Configuration..................................................................................................83 4.9 TMS Security.................................................................................................................84 4.9.1 Client Authorisation Configuration.........................................................................84 4
  • 5. 4.9.2 User Authentication Mode.......................................................................................84 4.9.3 Authentication Server..............................................................................................85 4.9.4 Domain Options.......................................................................................................85 4.9.5 User Group (Optional) / Admin Group (Optional)..................................................86 4.9.6 RightFax® Options..................................................................................................86 4.9.7 Access Mobile number from RightFax® field.........................................................86 4.9.8 Save Configuration..................................................................................................86 4.10 TMS Data Purge..........................................................................................................86 5 Trouble Shooting.................................................................................................88 5.1 TMS LogBrowser..........................................................................................................88 5.2 TMS Diagnostics...........................................................................................................91 5.2.1 TMS IP Client Component......................................................................................91 6 Quick Reference..................................................................................................92 6.1 TMS Server....................................................................................................................93 6.1.1 Message Allocation..................................................................................................93 6.1.2 Delivery Notifications..............................................................................................93 6.1.3 Outgoing Only..........................................................................................................94 6.1.4 Maximum SMS Message Size.................................................................................94 6.1.5 Sending an Email from an SMS Message................................................................94 6.1.6 Security ...................................................................................................................95 6.1.7 Message Encryption.................................................................................................99 6.2 Email Gateway............................................................................................................100 6.2.1 Sending Email as an SMS Message.......................................................................100 6.2.2 Subject Line Only..................................................................................................100 6.2.3 Email Notifications and Validation........................................................................100 6.2.4 Restricting Email Users.........................................................................................100 6.2.5 Removing Email Disclaimer..................................................................................101 6.3 File Processing.............................................................................................................102 6.3.1 Outbound Processing.............................................................................................102 6.3.2 Inbound Processing................................................................................................109 7 TMS Client Components..................................................................................110 7.1 TMS Client...................................................................................................................110 7.1.1 Server Connectivity................................................................................................110 7.1.2 Main Application Window Modes.........................................................................111 7.1.3 TMS Client Icons Explained..................................................................................114 7.1.4 Sending and Receiving Messages..........................................................................115 7.1.5 Create a New SMS Message..................................................................................116 7.1.6 Select Contacts.......................................................................................................117 7.1.7 Send Options..........................................................................................................117 7.1.8 Signatures...............................................................................................................118 7.1.9 Setting up Contacts................................................................................................118 7.1.10 TMS Contacts......................................................................................................118 7.1.11 Create a Local Contact.........................................................................................119 7.1.12 Create a Group of Local Contacts........................................................................119 7.1.13 Inbound SMS To Contact List.............................................................................121 7.1.14 Modify Contact....................................................................................................124 5
  • 6. 7.1.15 The System User..................................................................................................124 7.1.16 Importing Contacts...............................................................................................124 7.1.17 Importing Users....................................................................................................126 7.1.18 Creating New Users.............................................................................................127 7.1.19 Modify User Details.............................................................................................130 7.1.20 Delete a User........................................................................................................132 7.1.21 Create a New User Group....................................................................................132 7.1.22 Modify a User Group...........................................................................................132 7.1.23 Delete a User Group............................................................................................133 7.1.24 Modify Call Charges............................................................................................134 7.2 TMS Outlook Client....................................................................................................135 7.2.1 E-Mail Validation Errors.......................................................................................137 7.2.2 E-Mail Access Errors.............................................................................................137 7.2.3 E-Mail Notification Messages...............................................................................137 7.3 TMS Reports...............................................................................................................139 7.3.1 Overview................................................................................................................139 7.3.2 TMS Reports Application......................................................................................140 Report Data Files................................................................................................140 Report Export......................................................................................................142 Command Line Arguments.............................................................................................142 Export Path.......................................................................................................................144 Scheduling Reports..........................................................................................................144 Report Viewer.....................................................................................................145 7.3.1 Stock Reports.........................................................................................................146 8 Developer Integration.......................................................................................182 8.1 XML File Interchange interface................................................................................182 8.2 Webservices.................................................................................................................182 8.3 COM API.....................................................................................................................182 9 Technical Support.............................................................................................183 9.1 Postal Address.............................................................................................................183 9.2 Web Address................................................................................................................183 9.3 Support.........................................................................................................................183 9.4 Sales..............................................................................................................................183 183 10 TMS Manager ...............................................................................................184 10.1 TMS Manager...........................................................................................................184 10.1.1 TMS Manager Summary......................................................................................184 10.1.2 Design..................................................................................................................184 10.1.3 Configuration.......................................................................................................186 Index....................................................................................................................187 6
  • 7. 7
  • 8. 1 Introduction Text Message Server (TMS) is an enterprise SMS Application suite with a prime focus on the integration with customers’ existing IT infrastructure. The TMS application enables corporations to incorporate the power of SMS messaging technology into their current messaging infrastructure without the need for any development or integration work. This document describes the key features of TMS, explains the installation procedures and provides the information necessary to configure and operate the TMS components. 1.1 Feature Review This section provides a brief overview of the key TMS functions. 1.1.1 Connectivity • GSM or Internet IP Connectivity Supports all main mobile networks • IP Connectivity (Recommended) TMS IP module allows us to utilize the power of the Internet to deliver SMS messages to the mobile phone. At installation a pre-determined IP address is specified pointing all SMS traffic to the TMS SMS Internet Relay Station for the delivery and receipt of SMS messages. Messages are billed on a monthly basis with detailed reports on all messages sent. IP Delivery requires a connection to the Internet via either Lease Line, ISDN, ADSL or dial-up (PSTN). Incorporated resilience enables automatic failover to GSM Modem transmission in the event of an IP outage. 1.1.2 Email Integration 1.1.2.1 Email to SMS routing • TMS extends the corporate email system to mobile phone users. Email messages, meeting requests and contact information can be delivered from the corporate email system to any mobile phone. A Microsoft Outlook plugin enables mobile phone information to be extracted from the Exchange server’s phonebook or contacts folders as well as from TMS’s own contact database. SMS messages are addressed as email addresses in the format mobilenumber@tms.com, tms.distributionlist@tms.com or tms.firstname.lastname@tms.com. The Microsoft Outlook plugin will automatically populate the addressees. • Email integration supports mixed address types. Messages can be sent to a mixture of recipient types both email and SMS in the same message. • TMS provides notification of your SMS Messages. Email SMS messages generate optional notification emails when the SMS is sent, delivered or is found to be invalid. The email is returned to the sender to ensure that they are kept informed. • TMS minimises the size of the SMS message text. Features such as the automatic removal of Company Disclaimer/Confidentiality clauses or the sending of only the email subject line ensure that only the key data is transmitted in the SMS message. TMS automatically takes care of SMS Message splitting according to the 8
  • 9. constraints of the SMSC (Short Message Service Centre) (that you employ. TMS also allows the setting of a maximum message length so that dozens of SMS messages are not generated from an overly large email body. • You can specify the SMS Return number (IP Connectivity version only). TMS can be configured so that SMS Messages sent via the IP network show the sender as a centralised return number, the email users’ own mobile phone number or alternatively as a textual description, such as a company name or brand. • You can block SMS messages to International numbers or premium shortcodes. TMS allows for a whitelist file to be defined that defines the format of mobile numbers acceptable by the system. 1.1.2.2 SMS to Email Routing • SMS inbound routing options. Where all SMS messages are returned to a centralised number, TMS can allocate the SMS to the correct user via: • Direct Routing Useful for marketing campaigns where the replies need to be captured easily and received into one place. • Content Routing Messages can be routed to a user by the means of a keyword or short code. This is useful for internal use where staff might use either telephone extension numbers or initials to route the message to the correct recipient. • Manual Routing Inbound messages can be monitored by a user who then manually routes the messages. • MSISDN Routing over IP MSISDN or virtual mobile number as they are sometimes referred to are allocated to individual user(s).This can be found in the Modify User details (DDI) 1.1.2.3 Messaging • Direct emailing from SMS. Registered TMS Users may use their TMS Server as a gateway to send emails direct from their mobile phone, even if their mobile phones are not email / internet enabled!. The user simply enters the email address followed by the text message. The email is delivered through the users corporate email account so that the email recipient may reply. Both internal and external email addresses are supported. 9
  • 10. 1.1.3 TMS Client As an alternative to an email client such as Outlook, the TMS application includes a powerful client Microsoft Windows application for sending, receiving SMS messages and the managing of contacts: Key features: • Supports various Security models The TMS Client can operate in native mode, where user passwords are required to gain access. In OS Pass-through mode, where the current logged-on user’s credentials are validated against the Active Directory/Domain Controller or in RightFax® Mode, where the users are authenticated against an existing Open Text RightFax® installation. • Personal & Global Phonebooks. • The TMS Client provides support for the definition of global and local contacts as well as global and local groups (distributions lists). This operates in a similar way to Microsoft Outlook contacts. • Automatic Contact Management from Inbound SMS.The TMS Client provides special processing of inbound text messages to automatically add the sender as a new contact allocated to a Group Phonebook. When a Personal or Global Group is created, options are available to set keywords for SMS opt-in and opt-out features; including text replies that are returned to the sender. For example, a Group could be created named FOOTBALL with an Opt-in keyword of ADD and an Opt-out keyword of REMOVE. If a text is received starting with FOOTBALL ADD, the mobile details of the sender will be added as a new contact of the FOOTBALL group – a return SMS can be defined that acknowledges that the sender’s mobile has been subscribed. Similarly, a text of FOOTBALL REMOVE would unsubscribe the sender’s mobile details from the group. • This is a useful feature for advertising campaigns or for subscription-based services based on text messaging. • Phonebook import facility Phonebook entries can be imported from existing databases into Private or Public phonebooks. • User import facility User Accounts can be imported from comma separated value (csv) files to speed the process of account creation. Note: This is only applicable when using TMS Native Authentication (for AD/Domain authentication, the accounts exist at the OS level). • Phonebook Group Entries Both Single and Group entries can be added to both the personal and global phonebooks. This allows single messages to be easily sent to multiple recipients. 10
  • 11. • Schedule messages for future date and time delivery The client utility allows you to specify future delivery of your messages, this includes support for both date and time delayed delivery. • User customisable signatures Users can create their own text signatures which can then be added to the end of each of their messages by default. • Supports auto-splitting of messages over 160 characters Messages over 160 can be split into multiple messages and delivered to the recipient with a page reference. • Route to email or mobile Received messages can be automatically forwarded into your email account or onto another mobile number. • Automated Reply – each user can enable this feature that sends a user specified text as a response to a text being received into the user’s inbox. This can be used as an out of office notification. • Email integration supports mixed address types Messages can be sent to a mixture of recipient types both email and SMS in the same message • Delivery Notification To provide the sender with peace of mind of the message’s delivery, the message can be sent with a delivery notification request. • TMS allows for a whitelist file to be defined that defines the format of mobile numbers acceptable by the system. • Client Utility features include: o Inbox & Sent Items mailbox views. o Users displayed under a department hierarchy to simplify Administration tasks. o Reply to messages. o Forward messages to internal or external users. o Users have access to shared messages folder. o Tag messages as read/unread. o Familiar email type application look and feel. 11
  • 12. 1.1.4 Reporting A reporting system is included that provides summary and detail reports for both outbound and inbound messaging. The summary reports include graphical dashboards that show the current usage/trends over standard reporting periods, billing reports that show cost breakdowns by users and departments (TMS Groups), volume-based reports showing your national and international messaging grouped into various categories. The detail reports allow you to identify which users are sending to specific numbers or provide a breakdown of messages by user or recipient or to track inbound message traffic. In total there are 21 predefined reports and new reports can be created by the client themselves (The Reports are designed via VS2005 which is a free of charge component on SQL Server installations). Alternatively contact Avanquest- ProcessFlows for a quote on designing reports to suit your needs. The Report Viewer application can be installed on any PC that has the TMS Client installed. A command line interface allows reports to be scheduled for creation via the Scheduled Task facility of the Microsoft Windows® operating system. The reporting system is based on Microsoft SQL Reporting services and a full set of report RDL files are included in the release. These can be imported into an existing or new SQL Reporting server. 1.1.5 Customer Integration Most corporations utilise the TMS email gateway as an integration point for any applications that they want to SMS enable. However, TMS provides the following alternative integration mechanisms: • TMS WebServices A Set of SOAP compliant WebServices are available to allow integrators to quickly build bi-directional SMS capability into their applications. This component is built in ASP.NET 2.0 and requires IIS 5 or 6 for hosting. The WSDL information is available from TMSWebServices.asmx?wsdl following installation. • TMS COM API For C++ & VB Developers a distributed (DCOM) component is available that enables bi-directional SMS capability to be added to your applications. • TMS File Processor (XML or formatted text) This service component provides a file-based interface for sending and receiving SMS Messages. XML files or formatted-text files, that conform to the TMS Standards, can be dropped into a user specified directory. The TMS File processor will then deliver these to the TMS Server for transmission. Any errors or problems are notified by the TMS File Processor by moving the files to an error directory and appending the error information onto the filename. Inbound SMS messages, in addition to email or TMS Client delivery, can be written to text files and placed in a user specified pickup directory for a Customer application to consume. 12
  • 13. • TMS Printer The virtual print driver SMS-enables ANY application that can print! As well as Microsoft Windows® desktop applications, automated back-end or legacy systems can also use this method to easily integrate with the TMS Server for SMS transmissions. This method is also useful if you need to SMS-enable other operating Systems or platforms such as AS400, Apple Macintosh etc. The printed document must conform to one of the supported formats which consist of comma-separated mobile numbers and messages, a multi-line format that allows many messages to be generated from a single document or an XML format for ultimate control. Users can even encapsulate the section of the document that contains the SMS information through the use of special Text tags in the document. This is useful when printing from applications as these normally add pagination information to the printed output that would invalidate the format. . 13
  • 14. 1.2 TMS Architecture Overview At the heart of the TMS Application suite resides the TMS Server, which is responsible for the inbound and outbound delivery of SMS messages. The TMS Server can be purchased with the optional IP interface which enables delivery of SMS over the Internet using secured services (for further information see the TMS IP white paper). This option provides a cost benefit to customers as a cheaper SMS unit price is achieved. The TMS server manages the transmission (over GSM & IP) and receipt (over GSM and IP) of SMS messages, incorporating any required data encoding, splitting and concatenation. The TMS Server facilitates the return of transmission and delivery notifications to the user base and handles the inbound SMS routing logic. The behaviour of the TMS Server is user configurable via a Control Panel applet. The TMS SMTP E-Mail Gateway accepts SMS requests originating from the customers e-mail system. The gateway processes the email contents ensuring validity and applying user-defined data filters to ensure only applicable data will be sent in the SMS message. The gateway expands TMS distribution lists and contacts into actual mobile numbers and presents the request to the TMS Server for delivery. The TMS File Processor provides a bridge between files and SMS for both inbound and outbound messages. The user can configure the file locations and specify how 14
  • 15. fields in the file are separated (for formatted text files). Outbound requests are validated, expanded for each specified recipient (a recipient can be specified as a mobile number, a TMS Contact or TMS Distribution list) and presented to the TMS Server for onward delivery. Inbound SMS Messages are dropped into a user specified directory and are then available for consumption by Customer applications. A bi-directional XML file interface has been incorporated into TMS v7. Integrators can create XML files to send SMS messages to mobile phones and track the status of each message (failed, sent or delivered to Mobile etc). The XML Schema is extensible so that integrators may add their own tags to provide cross-reference to their own systems. Bulk messaging is fully supported allowing single or multiple messages to be delivered to multiple recipients. Per message tags are used to specify the level of message tracking required, this ranges from send-only with no feedback on message progress to a full end-to-end process where each message can be fully tracked and tied back to the integrator’s system. The process requires that integrators drop compliant XML files into a user-configurable directory. The system will pick up the files and process the content. If tracking is required, the system will produce an output XML file following the processing that contains the successfully processed messages augmented with Message Ids that uniquely identify each individual SMS. While the SMS messages are being sent or delivered, the system creates XML Status files that detail the Message Id and new status. Integrators can process these files to maintain a real-time view. Inbound SMS messages can also be persisted as XML files in a user-configurable “drop” directory. Integrators can then process the content into their own systems. All TMS Components store their information in the TMS Database ensuring data resilience and integrity. The database provides a historic repository of usage, from which TMS Reports are produced. As of Version 6, Microsoft SQL Server is the default (and recommended) Database technology, Microsoft Access is still supported, but without the Enterprise Reporting capability. The TMS Installation comes complete with SQL Server 2005 Express installers which is license free. Obviously, customers may install to an existing SQL Server 2000 or 2005 instance if preferred. Client access to TMS can be achieved through an email client (such as Microsoft Outlook) or the TMS Client. For Outlook users a convenient plug-in is available to access TMS and Exchange phonebooks and Public Folders to simplify the email addressing process. The TMS Client is a comprehensive application with inbuilt Global and Local Phone books, inbound and outbound SMS mailboxes and user configuration facilities. The TMS Client can integrate into the Customers Active Directory, NT domain or RightFax systems for user authentication or operate independently with its own user base. 15
  • 16. A set of integration components are available for developers wishing to incorporate SMS capability into their applications. The TMS Apis are available in COM, WebService, SMTP and XML variations. Each core TMS Component can be installed separately and operate independently with no inter-component dependency. The usage of a component is controlled through a licensing subsystem which specifies the components that may run and also the number of concurrent users that are supported by each component. For information on the available licensing options contact your Avanquest UK sales representative. 16
  • 17. 2 Installation Procedures Three standard windows installation applications are required to successfully install the TMS Server (and additional TMS Modules), the TMS Client software, and the TMS Outlook Plug- in. The “TMS Server v7 Setup” installation application installs the following components: a) TMS Server * b) TMS SMTP Gateway * c) TMS File Processor * d) TMS Reports * e) TMS Printer f) TMS Licence Manager g) TMS Log Browser h) TMS Diagnostics Utility i) TMS Client j) TMS IP Status Monitor k) TMS Licence Manager All TMS Server components are installed, but only licensed components can be run – licence components are indicated by an asterisk (*). 2.1 TMS Server Installation 2.1.1 Minimum System Requirements • Microsoft Windows 2000SP4 2003SP1 or above • Windows XP SP2 or later (Special install instructions contact Avanquest support) Windows Vista SP1 • 256 MB RAM • 5GB of uncompressed usable hard drive space • IIS with SMTP gateway option installed • .NET Framework Version 2 prior to the TMS installation • Mouse, Keyboard, Monitor • An SVGA display card set to at least 800x600 dpi graphics resolution and 256 colours • CD-ROM or DVD ROM • Network interface card (NIC). The TMS server must be connected to your local area network (LAN) via a NIC. • Appropriate number of free COM ports for GSM modem connectivity A setup utility (See diagram “TMS Server Installer” below) is provided to simplify the installation of the TMS Server. 17
  • 18. 2.1.2 Welcome Screen Running the TMS Server Installation Application you are immediately presented with a Welcome screen. 2.1.3 System Backup Message It is recommended that a full backup of your system is made before installing any new software, as shown in the next screen. If you do not have a recent backup, it is suggested that you exit the TMS Server Installation Application until you have a suitable backup. 18
  • 19. 19
  • 20. 2.1.4 Collect User Information It is necessary to insert the name of the licensed person and company of the TMS Server software. This is accepted in the next installation screen – the User Information Screen. 20
  • 21. 2.1.5 Additional Setup Information Before the installation continues, an information screen is presented detailing some of the activities that are required to be completed before the TMS server can be used: • To start the TMS Server, valid licence codes for the purchased TMS Modules should be resourced from Avanquest UK. • After the Application has been installed the TMS Client Diagnostics application should be run to ensure that all server side components are functioning correctly. Please see the TMS Client Diagnostics section for more details. • After installation, the installer is requested to run the TMS Server Configuration Applet to complete the TMS Server Configuration. 21
  • 22. 2.1.6 Install Type The TMS Server can be licensed in three different ways:  TMS IP Server – This option is used to send and receive text messages using your existing internet connection.  TMS GSM Server – this option allows SMS messages to be sent and received via a GSM modem. Using this option allows messages to be sent without having the TMS Server connected to the Internet. 22
  • 23. 2.1.7 TMS Server Database Type The TMS Server can use either a SQL Server Database (2000/2005/2005 Express Edition) or a Microsoft Access database. It is recommended that a SQL Server Database is chosen. 23
  • 24. If the SQL Server Database option is selected, the next screen asks if you want SQL Server Express to be used, and offers to install SQL Server Express and the SQL Server Express Enterprise Management. 24
  • 25. 2.1.8 TMS Server Installation Folder The TMS Server can be installed on any local drive. The recommended folder is “C: Program FilesTMS Server”. This dialog is shown in all installation types. 25
  • 26. 2.1.9 TMS Shortcut Folder The TMS Shortcut Folder allows the User to specify which “Start->All Programs” folder is created to store the shortcuts to the TMS Server Applications. This dialog is shown in all installation types. 26
  • 27. 2.1.10TMS Database Folder/SQL Server Name If the SQL Server Database was chosen, then the installer requests the computer machine name where SQL Server is installed. If the Access Database was chosen, then the installer requests the folder where the TMS Database is to be stored. It is recommended that the TMS Database Folder is created under the TMS Server folder. For example: “C:Program FilesDatabase”. This dialog is shown in all installation types. 2.1.11TMS Audit Folder The TMS Audit Folder is used to store the TMS Server Log (Audit) files. The Log files allow diagnostic information to be collected about the activities the TMS Server is currently performing. This is a very useful mechanism to examine what the TMS Server (and associated TMS Server Modules) is currently doing. This dialog is shown in all installation types. 27
  • 28. 2.1.12TMS Backup Folder Settings This dialog is shown in all installation types. 28
  • 29. 2.1.13TMS File Processor Settings This dialog is shown in all installation types. 29
  • 30. 2.1.14TMS GSM Settings The TMS GSM Settings screen allows the user to select which mobile operator. This is only presented if a GSM Installation has been selected. 30
  • 31. 2.1.15TMS IP Configuration TMS IP Configuration can be configured during setup. If you do not have your IP Configuration details, they can also be entered from the TMS Control Panel applet. 31
  • 32. 2.1.16TMS Email Gateway Configuration The SMTP server name can be entered as part of the installation. 32
  • 33. 2.1.17TMS Printer The decision to install the TMS Printer is chosen in this dialog. This can be installed at a later date by running the TMS Printer installer separately, which is included as part of the default installation. 33
  • 34. TMS Folders Display The folders chosen to install the TMS Server are presented in this dialog. 34
  • 35. 2.1.18TMS Installing Files During the installation of the files a progress bar is displayed. 35
  • 36. After the files have been installed, the TMS Server Components are configured. This may take several minutes. If SQL Server Express or the SQL Server Enterprise Manager was chosen and the Microsoft .NET Framework 2.0 has not already been installed, the installer will ask to install it. The Microsoft .NET Framework 2.0 installer is installed. Please follow the installation instructions for the Microsoft .NET Framework 2.0 Installation. 36
  • 37. Once the Microsoft .NET framework has been installed (if required), and if SQL Server Database option was selected then the following screens will be presented. This screen asks to enter the Machine Name of the SQL Server and the name of the database. Note: For SQL Express the server name is specified as Machine NameSQLEXPRESS by default unless there is an existing SQL Express installation. Please confirm the proper name first by connecting to SQL Express through the Management Studio. If you get a “failed to connect” error it is most likely that the Server Name is not correctly specified/ formatted 37
  • 38. The Database name must be TMSDB. Pressing the Run button will install the TMS Database on the required Server. The Database will install automatically. 38
  • 39. Once the SQL Server database has been installed, the Setup application will ask if data from an existing TMS Database should be migrated to the new database. 2.1.19TMS Upgrade During this part of the installation, the setup application will ask if you need to upgrade TMS Data from a previous TMS installation (. It is suggested that you back up your existing Database) If you are upgrading from versions prior to version 6 please contact Avanquest- ProcessFlows for further information. 39
  • 40. The following dialog allows you to enter the SQL Server name for where the TMSDB database resides.(please note for sqlexpress the form must be servernamesqlinstance name). Make sure you change the Database name from TMSDB-Version6 to TMSDB 40
  • 41. Then select yes to confirm the Upgrade of the database 41
  • 42. 2.1.20TMS Reboot Once the installation has completed the Setup application will ask if you want to reboot (recommended). 42
  • 43. 2.2 TMS Printer 2.2.1 Minimum System Requirements • Microsoft Windows 2000Pro SP4, Microsoft Windows XP, Windows Vista • RAM - Minimum 32Mb or as per Operating System requirements • TMS Server installed onto the same Domain 2.2.2 Welcome Screen Running the TMS Printer Installation Application you are immediately presented with a Welcome screen. 43
  • 44. 2.2.3 TMS Printer Install Folder The TMS Printer Install Folder allows the user to specify where they want the client application to be installed. By default “C:TMS Server” is given. It is recommended that the same folder is chosen as the TMS Server folder. 44
  • 45. 2.2.4 TMS Printer Shortcut Folder The TMS Printer Shortcut Folder allows the user to specify the name of the Application Group installed to the Start->Program Files list. By default this is named “TMS Server”. 45
  • 46. 2.2.5 TMS Printer Ready to Install The TMS Printer “Ready to install” screen tells the user which settings they have chosen to install the TMS Printer. 2.2.6 Redirection Port Monitor After the TMS Printer has finished installing the files, it will ask to install the port monitor. 46
  • 47. Selecting “Yes” will install the port monitor, and once complete it will display an Installation Successful dialog. You will then be presented with a dialog showing the following instructions to install a new TMS Printer in the Printers Control Panel Applet. 47
  • 48. 2.2.7 TMS Printer Installed Successfully Once the installation has completed the following “TMS Printer Installed Successfully” window will be displayed, signaling that the TMS Printer application has been successfully installed. 48
  • 49. 3 TMS Client 3.1.1 Minimum System Requirements • Microsoft Windows 2000Pro SP4, Microsoft Windows XP, Windows Vista • RAM - Minimum 32Mb or as per Operating System requirements • TMS Server installed onto the same Domain 3.1.2 TMS Client Installation A setup utility is provided to simplify the installation of the TMS Client. If a roll out of TMS Clients is required, the Client can be run in silent mode using /s after the install name, i.e. from a command line run: “TMS Client v7 Setup.exe” /s When the application is not run in Silent mode, the following screens are displayed: 3.1.3 Welcome Screen Running the TMS Client Installation Application you are immediately presented with a Welcome screen. 49
  • 50. 3.1.4 TMS Client User Information The TMS Client User Information screen allows the licensed user to enter their name and company name. 50
  • 51. 3.1.5 TMS Client Install Folder The TMS Client Install Folder allows the user to specify where they want the client application to be installed. By default “C:Program FilesTMS Client” is given. 51
  • 52. 3.1.6 TMS Client Shortcut Folder The TMS Client Shortcut Folder allows the user to specify the name of the Application Group installed to the Start->Program Files list. By default this is named “TMS Client”. 52
  • 53. 3.1.7 TMS Server Name The TMS Client “Server Name” screen requests that the User enters the Computer Name of the TMS Server. 53
  • 54. 3.1.8 TMS Client Ready to Install The TMS Client Ready to Install screen tells the user which settings they have chosen to install the TMS Client. 54
  • 55. 3.1.9 TMS Installation Progress The TMS Installation Progress screen shows the user the progress of the TMS Client files being installed. If MDAC (Microsoft Data Access Components) is not installed then the TMS Client Installer application will automatically install it. Finally the TMS Client Installer will ask if the messages are being sent via GSM Modem. 55
  • 56. 3.1.10TMS Finish Successfully The TMS Finish Successfully screen tells the user that the installation has been completed. If necessary the Installer will reboot the computer to complete the installation phase. 56
  • 57. 3.2 TMS Outlook Client 3.2.1 Minimum System Requirements • Microsoft Windows 2000Pro SP4, Microsoft Windows XP, Windows Vista • RAM - Minimum 32Mb or as per Operating System requirements • Microsoft Outlook 200020032007 (with cdo installed – this is not installed by default) • TMS Server installed onto the same Domain 3.2.2 TMS Outlook Welcome Screen A setup utility is provided to simplify the installation of the TMS Outlook Plugin. If a roll out of TMS Outlook Plugin is required, it can be run in silent mode using /s after the install name, i.e. from a command line run: “TMS Outlook Plugin v6 Setup.exe” /s 57
  • 58. 3.2.3 TMS Outlook Plugin User Information 58
  • 59. 3.2.4 TMS Outlook Plugin Installation Folder The TMS Outlook Plugin is automatically installed to a special Microsoft Office Addin folder. 59
  • 60. 3.2.5 TMS Outlook Plugin Install Information The information about where the Plugin is to be installed and the shortcut folder are displayed before the setup application starts to copy and install the Plugin files. 60
  • 61. 3.2.6 TMS Outlook Plugin File Installation Progress Progress of the file installation can be seen by the progress bar in the File Setup step. 61
  • 62. 3.2.7 TMS Outlook Plug-in Finished Successfully After all the files have been installed, and the various Plugin components have been registered, the TMS Outlook Plugin installation is complete. 62
  • 63. 4 TMS Software Configuration TMS Server consists of the following application components: 4.1 Services DevHQ Licence Manager – the licence manager service provides the licensing functionality. The Licence Manager is a dependency of any other TMS Service component that requires licensing and will start executing automatically if any of these services start. Configuration of licensing information is provided by the Control Panel TMS Server Configuration applet. DevHQ Log Browser – the log browser is a special diagnostic utility, which constantly monitors the activities of all TMS Server Components. The log browser can be started and stopped without affecting any other TMS Server components. DevHQ SMTP to SMS Server – the “SMTP to SMS Server” service provides the functionality required for the TMS Server to interact with an SMTP server. TMS File Processor – the file processor allows inbound SMS messages to be saved to a folder for third party application to pick up and use, and outbound SMS messages to be picked up and sent out as SMS Messages by the TMS Server. TMS Server – The TMS Server is the root component of the TMS Application Suite handling the transmission and receipt of SMS. TMS External Authorisation – The TMS External Authorisation is a lightweight component required by the TMS Server responsible for user authentication against the Active Directory/Domain or RightFax servers. TMS Status Monitor – The Status Monitor notifies TMS Client users of any change to their inbox. TMS Manager – The TMS Manager Service monitors the TMS Server,SMTP,File Processor and License Manager services and identifies situations where the services are not operating correctly. 63
  • 64. 4.2 DCOM Server The TMS Client requires a DCOM component called SMSBusObj.exe, which is the middle tier business component between the TMS Server and the TMS Client. 64
  • 65. 4.3 Control Panel Applet TMS Server Configuration 65
  • 66. 4.4 TMS Service Management 66
  • 67. This dialog manages the service components of TMS. The display refreshes the current status of each service every 10 seconds. The key services may be started and stopped from this dialog. It should be noted that the Licence Server is a dependency of the TMS Service, SMS SMTP Service and the File Processor Service and therefore this may not be stopped whilst one of these services is running. The COM Services frame displays the status of the COM services that operate as NT Services. These services cannot be started or stopped from this dialog as their lifecycle is automatically managed by the client applications (SMSBusObj DCOM server). Service Status Key: The Service is not installed or not running. See the service status text for the actual reason. The Service is running correctly. The Service status is unknown. This icon will change to one of the first two icons once the application has successfully queried the Service Control Manager. 67
  • 68. 4.5 TMS Licence Manager This dialog displays the licensing status of all of the TMS Components that have been installed on your system. The Application Name Combo should be used to select the component to be shown. The Licence Code and Licensed Users fields will display the current registered values. These fields will be blank following the initial installation. To licence the component you should call your TMS Supplier (note: you must provide them with the Install Number, order reference or other proof of purchase). To enter a new or change an existing licence, enter the Licence Code and Licensed Users values that your TMS Supplier provided you with and select the "Update Licence" button. If successful, the following dialog will be displayed. 68
  • 69. If you incorrectly enter any of the details or the licence details that you have been given are not valid, the following dialog will be shown: The most likely cause for this error is either the Install Number given to your TMS Supplier was incorrectly specified or the date on your computer is incorrect. The Licence code includes an embedded start time, therefore if your computer date is behind real-time, the licence will not be accepted. 4.6 TMS Server 69
  • 70. 4.6.1 Main Settings 4.6.1.1 Service Name This must be set to the exact text entered in "Configure Modem"->Services- >General->Name field. See the Configure Modem section below. 4.6.1.2 Data Source This should not be changed as it is set at install time. This is the name of the ODBC Data Source used by the TMS Software. 4.6.1.3 Poll Period The frequency that the TMS Service looks for new outbound SMS Messages. As the polling is lightweight, increasing this value is unlikely to improve system performance. Most installations set this value to 30 seconds. 4.6.1.4 Embedded User Delimiters The Start and End Delimiters can be one or more characters. These are used during inbound SMS processing as a means of determining which TMS User the message is to be allocated to. For example the SMS <gary> thanks for the message would be allocated to the user that has a short name set as "gary". 4.6.1.5 Check First Word for Short Name This is used as an alternative to the Embedded delimiters. If set, the first word of an inbound SMS is checked against the TMS User base for a matching short name. If found, the SMS will be allocated to that user. 4.6.1.6 Rcvd Msg Sender Check Where an inbound SMS has not been allocated to a TMS user via either of the above two options, the system can look for a user that has recently sent an SMS to the mobile from which this inbound SMS has been received. If a match is found, the SMS is allocated to that user. The value entered for this field relies very much on the way TMS is used within the Organisation (for example, if many users send messages to the same recipient, there is a good chance that an SMS reply will be allocated to the incorrect user). To disable this feature set the field value to 0. 4.6.1.7 Sending SMTP Domain Where inbound routing to email is being used, this field must be set to the name of the SMTP domain that will process the mail deliveries. 4.6.1.8 Size Limit for Outbound SMS This is typically used when the SMS Service provider does not support Message splitting. In this case, this field should be set to the maximum message size supported (typically 160). Where the service provider does support splitting, you may set this value to the maximum size of message you want to allow. If you set this to 1600, this limits any outbound SMS to around 10 splits. This field is also used by the TMS client to force a stop of text entry at this maximum limit. 70
  • 71. 4.6.1.9 Single Recipient Quota This parameter if non 0, sets a maximum number of SMS messages that a single user can sent in a 30 minute period. The idea behind this is to stop any SMS message floods. For example, it is possible to create full-circle email rules which result in the same SMS being sent out continuously. 4.6.1.10 Exceeded Quota Command If the above quota is reached in a given 30 minute period, the system will execute the command specified in this parameter. It is typical to execute a NET SEND to send a message to the network administrator. 4.6.1.11 Send System Response Messages Normally, this is left unchecked. When checked, the TMS Server will reply via SMS to inbound messages whenever exceptions occur - such as failing to locate the user to which the received message should be allocated. This could be a costly facility because many SMS messages could potentially be generated by this function. 4.6.1.12 Enable Delivery Notification When checked, users may request (on a per message basis) notification that an SMS has been delivered to the recipient. This availability of this feature depends on the SMS Service provider being used, as this is not supported by all providers. 4.6.1.13 Enable user Emailing When checked, inbound SMS messages from users registered as TMS Users can be converted to an email to any internal/external email address. For this to operate, the user must enter a valid formatted email address as the first word in the SMS. 4.6.1.14 IP Configuration These fields will be greyed out for non-IP installations of TMS. These settings are used to define the configuration and validation of Web Service calls that are made by TMS for outbound messages. 4.6.1.15 Relay Station Address This is set to the IP address of the TMS Relay station to which outbound SMS messages are transmitted. The TMS Relay Station acts as a store-and-forward mechanism for all TMS Messages, providing facilities such as invoice generation etc. This is set at install time and should not be changed unless specifically asked for by your TMS supplier. 4.6.1.16 WebService Page This is set to the ASP Page on the TMS Relay Station that hosts the Web Services. This is set at install time and should not be changed unless specifically asked for by your TMS supplier. 71
  • 72. 4.6.1.17 Customer Name This field specifies the name of the company running the TMS Server. This field is included in the Web Services data to validate that the message requests are from a licensed installation. This is set at install time and should not be changed unless specifically asked for by your TMS supplier. 4.6.1.18 Account Name This field specifies the TMS Relay Station Login Name. This field is included in the Web Services data to validate that the message requests are from a licensed installation. This is set at install time and should not be changed unless specifically asked for by your TMS supplier. 4.6.1.19 Account Password This field specifies the TMS Relay Station Login Password. This field is included in the Web Services data to validate that the message requests are from a licensed installation. This is set at install time and should not be changed unless specifically asked for by your TMS supplier. 4.6.1.20 Receiving Modem Number This field specifies the default number or text that will be shown when a mobile receives an SMS from this installation. Normally, this would be set to the number of the connected GSM Modem, so that SMS replies are received and processed by the TMS inbound services. Where a company is sending mail-shots via SMS, they may choose to enter a textual value (such as a product name etc). This will be displayed as the sender on the recipient mobile. Textual values cannot be replied to by the receiver, as there is no underlying number to return messages to. Note: users may individually specify their own number as the sender. This field is only the default used where users have not set this feature. 4.6.1.21 Proxy ServerProxy Bypass |Proxy UsernameProxy Password Proxy Server - enter the address of your proxy server Proxy Bypass - Not usednot currently supported Proxy Username – If using Proxy authentication, enter the username of the authenticating user (Only Microsoft ISA serer is supported) Proxy Password - If using Proxy authentication, enter the password for the username of the authenticating user (Only Microsoft ISA server is supported) 4.6.1.22 Download Poll Rate Specifies the Frequency that the TMS Server will interrogate the Relay Server for inbound information (such as SMS messages and delivery reports). 4.6.1.23 IP Failover - (If IP Communication is down use GSM Modem) This field specifies the behaviour of TMS if a problem occurs with communication between TMS and the IP Relay Station. By setting this value to a number greater than 1, the TMS Server will failover to sending via GSM Modem after the specified number of minutes downtime. This will be of use to companies 72
  • 73. that send urgent SMS Messages that cannot be delayed for too long. This feature is disabled if a value of 0 is specified; TMS will not send any SMS messages until the IP Communication is back online. Note: This feature is not available for installations without a GSM Modem (No Modem is checked). 4.6.1.24 View Log This button is only applicable where an IP Failover period has been set. The button displays a dialog detailing the failover conditions that have occurred. This list is limited to 8K of text. 4.6.1.25 Encrypt data over IP If checked, all customer and message data is encrypted prior to transmission. Note: Encrypted data size is twice the size of the original data and therefore could affect throughput rates. 4.6.1.26 No Modem If checked, the TMS Service will operate in outbound SMS mode only via the IP network. No GSM modem is required. 4.6.1.27 Configure Modem To access the modem configuration dialogs, press the "Configure Modem" button. The TMS Server service must be stopped before you can access this function. 4.6.1.28 General Tab This display allows you to configure the behaviour of the SMS Modem spoolers. This alters the way that TMS communicates with the connected GSM Modem. Do not enable the Inbox or Outbox Spoolers. TMS Server service starts these as part of its initialisation. 73
  • 74. You can alter the checking interval if necessary, but the default value is normally sufficient. 74
  • 75. 4.6.1.29 Ports Tab The Ports Tab shows the COM port on which the GSM modem is installed. By selecting the COM Port from the list and pressing "Properties" you can customise your GSM modem Device Property settings, as shown in the following dialog. These three tabs allow you to specify details about the SMC and set any modem initialisation information. Normally, you would never have to change the SMC settings. If the GSM card that you are using in your modem has a PIN enabled, the Change PIN function will need to be run. The most likely setting changes that you will make are to do with the initialisation of the modem. For example, some GSM networks provide the facility of delivery notifications where an event is sent back to the sender modem to acknowledge that an SMS was delivered to the destination mobile. The following screen demonstrates the modem strings that need to be specified to enable this option. 75
  • 76. 4.6.1.30 Services Tab The Services Tab shows the details of the currently installed SMS Service Provider. If you ever change your provider, you will need to alter these settings. Normally this would be achieved by adding a new Service Provider and allocating this to the COM port you have connected the GSM modem to. Always ensure the “Default Service” is selected, without this no messages will be sent. The Properties button displays the currently installed provider information. For details on the specific settings for SMS Service providers, click here. 76
  • 77. The General Tab displays configuration options for the currently installed service provider. On the Splitting Tab make sure that the Splitting checkbox is selected. Without this you will not be able to send SMS messages over 160 Characters (you must also set the "Size Limit for outbound SMS" to 160 on the TMS Server tab - otherwise ALL SMS messages will fail to send) 77
  • 78. 4.6.1.31 Messages Tab This Tab allows you to alter the presentation of inbound messages by re- formatting line feeds. This is not normally enabled. 78
  • 79. 4.7 TMS EMail Gateway 4.7.1 SMTP Domain Name This should be set to the name of the SMTP domain from which mail will be accepted. The SMTP domain is normally locally installed as it is also used by the TMS Server for email SMS routing and email delivery notification (see Sending SMTP Domain setting). 4.7.2 SMTP Pickup Directory This is the directory in which the SMTP Gateway server detects new emails for processing. These files are dropped by the installed SMTP Server. 4.7.3 Poll Period (Secs) The SMTP Gateway server polls the pickup directory at this rate. 4.7.4 Maximum Message Size This field specifies the maximum number of characters that outbound SMS messages generated from email can contain. The SMS text is created from the email Subject and Body components. The Email Gateway will accept emails with content larger than this maximum, but will truncate the SMS text to this size. This is included to ensure that very large emails accidentally sent to the Email Gateway do not result in 79
  • 80. dozens of SMS messages being generated (as this could become expensive). You should set the value of this field according to your typical use. 4.7.5 Exclude email body from SMS text This box can be checked to prevent the email body text from being sent with an SMS message. In this configuration, only the email subject text is included in the SMS text. This feature may be used where a company includes large amounts of fixed text in the email body, such as a Company Confidentiality clause. See Remove disclaimer from email body as an alternative. 4.7.6 Receive email notification when SMS Sent This check box determines whether or not an email notification is provided when an SMS message is successfully sent by the TMS Server. If this facility is enabled, an email is returned to the SMS sender detailing the message that has been sent. 4.7.7 Receive email notification when SMS delivered by SMC This check box determines whether or not an email notification is provided when an SMS message is delivered by the SMC to the destination mobile. This feature will only operate correctly if the TMS Server has been enabled for Delivery Notification (see TMS Server check box), the modem initialisation string has been correctly set and most importantly, your SMS Service provider supports delivery notification messaging. 4.7.8 Restrict sending of SMS to registered users This check box is used to restrict the ability to send SMS messages to registered users only. If enabled, the email gateway checks that the email FROM address exists as an email address in the TMS User base. Note: If NT or RightFax authentication is enabled, a new TMS user is created on the first login via the TMS Client. therefore you must ensure that this action is completed by allnew users before they are able to send SMS messages via email. 4.7.9 Force use of TMS Mail Libraries (Tech Support use only) This check box is for Technical Support Staff only. If enabled, the TMS Server is forced to use the CDONTS.DLL library for all email processing (inbound and outbound) instead of the newer CDOSYS.DLL. 4.7.10Auto Create Email User Accounts When checked, emails received by the Service have a email address lookup performed on the TMS Users. If the email address already exists the email is associated to the user account. If no match is found a new user will be created based on the sender’s email address details. 4.7.11Authenticate Email Accounts via Active Directory This feature is only valid when TMS Security is set to Active Directory mode. When enabled the AD is checked for a matching email address (these need to be unique in the AD). If no matching email address is found the request will be bounced. For matched requests the email request will be associated against the correct AD user. This feature is important when using the TMS reports as this mode ensures that SMS messages are correctly associated against users and billing groups. 80
  • 81. 4.7.12Remove disclaimer from email body This text box enables the specified text to be removed from email messages. This would typically be used to exclude a standard Company Disclaimer, Privacy or Confidentiality clause from outbound SMS Messages. The exact text must be carefully pasted into this field. Note: Care must be taken when sending emails, which include previous email replies as any Company Disclaimer will have been indented and prefixed. The software will not detect these occurrences and therefore this text will be included in the message. 4.7.13Save Configuration This button will save the specified settings in the registry. The saved settings will be presented next time the Control Panel applet is accessed. 81
  • 82. 4.8 TMS File Processor 4.8.1 Outbound Configuration 4.8.1.1 File Pickup Directory This is the directory which the File server polls for new files dropped by a user or external application. Filenames and extensions do not have to comply with any standard formatting. 4.8.1.2 Processed Files Directory This is the directory in which the File server puts files that have been successfully processed. 4.8.1.3 Error Files Directory This is the directory in which the File server puts files that contained any errors and that could not be transmitted. Errors occur if the file contents are invalid, such as the wrong number of fields in the file, file over 8K in size, incorrect separator characters used, invalid recipient mobile number specified or a non- existent contact or group defined etc. 82
  • 83. 4.8.2 Inbound (Drop) Configuration 4.8.2.1 Enable This check box determines whether or not inbound SMS messages are to be dropped as text files. If enabled, every received SMS will be dropped into the Drop directory and given a unique filename. These files are then available to external applications for processing. Note: It is your responsibility to housekeep these directories. 4.8.2.2 Drop Directory This is the directory that will hold the Inbound SMS text files. 4.8.3 General 4.8.3.1 Poll Period (Secs) The File server polls the drop directory at this rate. 4.8.3.2 Maximum Message Size This field specifies the maximum number of characters that will be included in the SMS text. If the file message is longer that this number the text will be truncated. 4.8.3.3 Message Separator Character This field specifies the character which is used to separate the recipients from the message text. In the example below ‘,’ is used as the message separator. After initial detection, it can subsequently be used as part of the message text. 4.8.3.4 Recipient Separator Character This field specifies the character which is used to separate the recipients from the message text in the drop file. E.g. 0777123123;tms.paul.smith;0777999888,message text - here three recipients are specified; 2 mobile numbers and one as a contact name using ";" as the separator. 4.8.4 Save Configuration This button will save the specified settings in the registry. The saved settings will be presented next time the Control Panel applet is accessed. 83
  • 84. 4.9 TMS Security 4.9.1 Client Authorisation Configuration The User Authentication Mode and Authentication Server can be configured as part of the Client Authorisation Configuration. 4.9.2 User Authentication Mode This can be one of the following values: • TMS – Indicates users are authenticated using the TMS database user definitions. • NT Domain – Indicates users are authenticated using NT User authentication. • RightFax – Indicates users are authenticated using the RightFax database user definitions. • Active Directory – Indicates users are authenticated against the corporate Active Directory. 84
  • 85. 4.9.3 Authentication Server This option is only available for Active Directory, NT Domain and RightFax User Authentication Modes, and specifies the name of either the Domain Controller or RightFax Server, which TMS will access to validate user logins. For Active Directory, this can be left blank and the system will automatically locate the appropriate server. 4.9.4 Domain Options Domain options are accessible only if Active Directory or NT Domain authentication is chosen as the User Authentication Mode (see above). 85
  • 86. 4.9.5 User Group (Optional) / Admin Group (Optional) If neither of these values are specified, all users defined on the specified AD/Domain Controller are authorised to use TMS. If either or both of these values are specified, only users from the specified group(s) are authorised to use TMS. The User Group members can access basic TMS functions, and the Admin Group members can additionally access administrative TMS functions. Groups can be manually keyed or selected using the “…” buttons. This presents the following dialog from which the required group can be selected: To select the group, either double-click the entry in the list or highlight the entry and press the "OK" button. 4.9.6 RightFax® Options The RightFax® Options are only accessible if RightFax® authentication is chosen as the User Authentication Mode. 4.9.7 Access Mobile number from RightFax® field This value is chosen from a drop down list of RightFax® User Coversheet fields and allows a user to "map" the RightFax® field that contains the user’s mobile number to the TMS user base. This is required as RightFax® does not have a dedicated mobile number field within its user definition. The value of the specified field will then be loaded into the user’s settings at login time. 4.9.8 Save Configuration This button will save the specified settings in the registry. The saved settings will be presented next time the Control Panel applet is accessed. 4.10 TMS Data Purge TMS V7 includes a new tab on the TMS Server Configuration Control Panel Applet to enable and define how and when data should be purged from the TMS Database. If enabled, TMS will automatically remove inbound & outbound SMS messages that have reached a defined age. 86
  • 87. 87
  • 88. 5 Trouble Shooting 5.1 TMS LogBrowser The TMS Logbrowser collects diagnostic information from the TMS Server Components. The following components can be monitored: • TMS Server • TMS SMTP Gateway • TMS File Processor • TMS External Authorisation • TMS Status Monitor • TMS Licence Server To start the TMS Log Browser, the TMS Log Browser Service should first be started, using the TMS Server Configuration Control Panel Applet, and pressing the Log Browser start button on the Server Management Tab. 88
  • 89. Once the TMS Log Browser Service has started, the TMS Log Browser Client Application can be run. If the TMS Log Browser Client cannot connect to the TMS Server and displays a dialog with a GetDiagnostics Call Fail (1722) message in it, then please click the Settings->Edit Settings… Menu item: Set the Server IP Address to the IP Address of the TMS Server, followed by the OK Button. After the TMS Log Browser has been configured correctly, it will start to display diagnostic information useful to determine if there are any problems with the TMS Server Installation. It is recommended that if there is a problem with the TMS Server that the TMS Log Browser and the TMS Diagnostics applications are used to first try to ascertain what the issue is. 89
  • 90. The TMS Log Browser can filter diagnostic information. For example if information just about the TMS File Processor is required, then set the “Process Filters” to TMSFileProcessor. Diagnostic information can be saved by clicking File->Save Log option which brings up the following dialog: It is recommended that both Errors and Diagnostics logs are saved, and sent to the TMS Support team if a problem with the TMS Server or one of its Components occurs. 90
  • 91. 5.2 TMS Diagnostics The TMS Server and TMS Client Installations include a TMS Diagnostics utility. The Diagnostics utility is able to test Server and Client components to ensure that they have been installed correctly. To use the TMS Diagnostics Utility, please enter the machine name of the TMS Server, and then press the “Check” button. It is normal for one of the SMTP libraries to fail, as most machines have one CDO library; either CDOSYS, or CDONTS. 5.2.1 TMS IP Client Component The TMS Server requires that the TMS IP Client Components are installed and configured correctly before the TMS Server can communicate with the TMS SMS IP Gateway. 91
  • 92. 6 Quick Reference The TMS product range is a very powerful enterprise level SMS Application Suite. Full integration between SMS and Email is provided, allowing Emails to be sent as SMS Messages, and SMS Messages to be sent as Emails. The diagram below shows a real world scenario of a full TMS Server configuration. TMS Enterprise Suite consists of the following modules: • TMS Server • TMS Email Gateway • TMS File Processor • TMS Backup • TMS Purge • TMS Reports • TMS Licence Manager • TMS Log Browser • TMS IP Gateway • TMS Client • TMS Licence Manager • TMS API (WebServices and COM Interfaces) 92
  • 93. 6.1 TMS Server The TMS Server facilitates the sending and receiving of SMS messages via a GSM Modem plugged into the TMS Server, or via the Internet, communicating with the TMS IP Gateway. The TMS Server allows inbound routing to Email to be configured by specifying an SMTP Domain name, allowing any received SMS Messages to be automatically routed to a given Email Address. For example, if User A has configured their Routing To Email address (a.user@emailaddr.com) then all received SMS Messages will be sent to their Email address. 6.1.1 Message Allocation The TMS Server automatically tries to determine which TMS User should receive an incoming SMS Message using four mechanisms:  DDI matching – If the SMS has been delivered to a DDI number (a virtual mobile number) associated to a particular user then the SMS will automatically be routed to that user’s inbox or email. When purchasing TMS, you can request bundles of DDI numbers which you then allocate to your workforce.  Searching the SMS Message for a TMS Users Short Name, i.e. User A might have the short name of “Fred”, so if an incoming message contains the text “<Fred>” at the start of the message then it will be automatically routed into the Inbox of User A. The delimiters “<” and “>” are default delimiters, and are configurable as part of the TMS Server Control Panel applet. The delimiters can also be switched off. In this case, if the word “Fred” is found at the start of the SMS message, then it will be routed to the Inbox of User A.  If the SMS Message was received within a defined time period, i.e. 15 minutes, of an outgoing message to the same number, then it will be automatically sent to the inbox of the original outgoing message. For example, User A sends an SMS Message to number 07122112211, if within 15 minutes 07122112211 replies it will be automatically entered into the Inbox of User A. However, a Short Name would override this setting. For example if the message contained a Short Name, then the SMS Message would be entered into the Inbox of the TMS User with that Short Name.  If a received SMS Message does not contain a Short Name, and is not a reply to a sent message within a specified period of time (Options 1 and 2 above) then there is no way to determine which TMS User should receive the message in their Inbox. To handle this situation, a special TMS User has been created, called the “System, or Shared” User. The System User has its own Inbox, which can be accessed by any TMS Administrator. When a Message is received in the System Inbox, any TMS Administrator can read it, and then allocate it to the appropriate TMS Users Inbox. If required, an automatic reply can be sent to any inbound messages that are entered into the System Inbox. The reply informs the sender that the message was received, but not allocated to a particular user and will not get a reply until the message has been allocated to a TMS User by a TMS Administrator. 6.1.2 Delivery Notifications Delivery Notifications can be enabled for each outgoing message. So, when an outbound message reaches its destination, a Delivery Notification is sent to the originating TMS User. Delivery Notification can be enabled or disabled and is not available from all SMS Message Providers. 93
  • 94. 6.1.3 Outgoing Only The TMS Server can be configured to only send (not receive) SMS Messages via the TMS SMS Gateway, which uses the Internet as the transport mechanism between the TMS Server and the TMS SMS Gateway. In this scenario, no GSM Modem is necessary, as all messages are outgoing. This allows the TMS Server to be installed with no additional hardware. 6.1.4 Maximum SMS Message Size The TMS Server has a Maximum Message Size setting, allowing only SMS Messages of a given size to be sent. By default this value is 1600 characters, which is the equivalent to 10 SMS Messages. This is very useful, just in case a TMS User accidentally sends a message of thousands of characters. For example a 64k message would equate to 409 SMS Messages, which would not only be costly, but also very annoying for the message recipient. If the GSM Network Service Provider does not support Automatic Message Splitting, this value should be set to 160. 6.1.5 Sending an Email from an SMS Message The TMS Server can convert received SMS Messages and send them out as Email messages. This facility can be enabled or disabled globally for all TMS Users. For example, let’s assume the following: The TMS Server GSM Mobile number is 07111223322 TMS User Fred has a mobile phone with number 07333112211 TMS User Fred has an Email address fred@emailaddr.com From his mobile phone, Fred sends the following SMS Message to the TMS Server (07111223322): greg@emailaddr.com Hi Greg, is the management meeting still arranged for 2:00 pm tomorrow? Fred When the TMS Server receives the SMS Message from Fred’s mobile phone, it finds the Email address, greg@emailaddr.com at the start of the message. This tells the TMS Server to send the following Email From: fred@emailaddr.com To: greg@emailaddr.com Hi Greg, is the management meeting still arranged for 2:00 pm tomorrow? Fred If Greg replies to the Email it will be sent to fred@emailaddr.com, making it transparent to Greg that the originating message was actually an SMS Message. 94
  • 95. 6.1.6 Security TMS Server uses three different security mechanisms to validate TMS Users. These are TMS Native Security, Active Directory Security, Windows Domain Security and RightFax Security. TMS Client TMS Client Domain Controller Security TMS Server RightFax Server 6.1.6.1 Native TMS Security If the TMS Administrator has set the Security Mode as TMS Native Security, then each new TMS User must be added to the TMS Server using the “New User” feature in the TMS Client. 6.1.6.2 Active Directory Security TMS incorporates integration into your corporate Active Directory. When configured for this mode TMS will authenticate users against the Active Directory and map their AD properties to TMS’s internal user records. Changes made to the Active Directory will be picked up in TMS at the user’s next logon. The field mappings are shown below: TMS = Active Directory User Name = User Logon Name (or Win2k Name if blank) Password = Active Directory Password (link to the AD password) Short Name = User Logon Name (first ‘X’ characters, can be set in registry) Full Name = Display Name User Group = Department (groups created from this field) DDI Number = Pager Route to Mobile = Mobile Route to Email = E-mail 95
  • 96. 96
  • 97. 97
  • 98. For other user properties specific to TMS that need to be maintained by the user rather that the System Administrator (such as the enabling forwarding to email, or using your own number on outbound messages), initial default values can be specified via a set of special template accounts. This will be of specific interest to Clients that only use Outlook to send messages as the system can be predefined to ensure that all users are set up for this configuration. Users of the TMS Client can obviously modify these values as and when required. 6.1.6.2.1 Email Users and AD TMS V7 also enables Outlook users of TMS to make use of the Active Directory features. If enabled, each email message received by TMS with have the sender email address checked in the Active Directory. If the email address is not associated to a valid and enabled account the SMS will not be sent and the email will be returned to the originator. Where the email address is matched to an active AD account the AD properties will be processed as described above. This ensures that the new reporting features will operate in the same manner as for users of the TMS Client (e.g. you will be able to report volumes & costings by users and departments). This feature also ensures that no email address spoofing or non- authorised users can send messages. 6.1.6.3 Windows Domain Security If the TMS Administrator has set the Security Mode to Windows Domain Security, then only users within the defined Domain can log into the TMS Server. When a user logs into the TMS Server for the first time, their Domain attributes are automatically captured and used to create a TMS User. If their Domain attributes change, these will be automatically updated the next time they log into the TMS Server. Further restrictions can be applied using Windows Domain Security. If required, a User Group can be specified, so that only members of a particular Domain Group can log into the TMS Server. Any users logging into the TMS Server who are associated to this Domain User Group will be created as normal TMS Users. If required an Administration Group can be specified, so that only members of a particular Domain Group can log into the TMS Server as administrators. Any users logging into the TMS Server who are associated to this Domain Administrator Group will be created as TMS Administrator Users. 6.1.6.4 RightFax Security If RightFax is being used, then it might be appropriate to use the RightFax Security Mode. This allows any current RightFax User to log into the TMS Server. When a user logs into TMS using their RightFax Details, the TMS Server queries the RightFax Server to determine if the user is a valid RightFax user. If so, the TMS login is successful. If it is the first time the user has logged 98
  • 99. into the TMS Server, the user’s RightFax details are captured and used to create a new TMS User. If the user’s details are changed in RightFax, the changes will be propagated the next time they log into the TMS Server. Because RightFax does not have a native field to hold a mobile number, one of the following fields from the Fax Coversheet can be a surrogate for the Mobile Field: • Company • City/State • General Fax Number • General Voice Number 6.1.7 Message Encryption If SMS Messages are sent to the TMS SMS Gateway over the Internet, then an option is available to send the data in an encrypted format. SMS Encrypted messages are decrypted by the TMS SMS Gateway and then forwarded onto the IP Service Provider that finally transmits the SMS Message over the GSM Network. 99
  • 100. 6.2 Email Gateway Very powerful Email integration has been designed into the TMS Server to make sending and receiving SMS messages completely seamless from various mail servers. For example TMS could integrate with Exchange, GroupWise or Notes, allowing SMS messages to be sent from their native Mail Clients. Contact Avanquest-ProcessFlows support for TechNotes on Exchange Lotus and GroupWise set-up. 6.2.1 Sending Email as an SMS Message For example, a person using an Email client sends a message to two people, the first person is sent an Email and the second person is sent the same message as an SMS Message, e.g. fred.smith@emailaddr.com tms.fred.smith@emailaddr.com The first address is a normal Email address, and the message is sent as an Email to Fred Smith. The second address is in a special format, which tells the TMS Server to look up the contact name Fred Smith and send the Email as an SMS Message. 6.2.2 Subject Line Only Email messages can be very long, and even though there is a maximum outgoing message size, it is possible to limit the size by sending only the Subject Line. To facilitate this, an Email Gateway option – “Exclude email body from SMS text” has been provided. 6.2.3 Email Notifications and Validation Sometimes it is difficult to know if a message has been successfully received by the recipient. The Email Gateway allows Successful Notification Emails to be sent to the originating users so they know that their message was sent successfully. Optionally, a delivery Email message can also be generated once the SMS Message has successfully been delivered by the Service Management Centre (SMC). In certain circumstances, (e.g. TMS Client Licences have been exhausted due to too many concurrent TMS Users), access notification messages can be sent to the originating Email user informing them of the Access Notification issue. 6.2.4 Restricting Email Users An organisation might not want all Email users to be able to send SMS messages via their Email client. For example, if a company has 200 users, it might decide that only certain people should be able to send SMS Messages via Email. This is facilitated by setting the “Restrict Sending of SMS to registered users” flag in the Email Gateway Control Panel applet. Once set, only registered TMS Users will be able to send messages via Email clients. If this flag is not set, then any Email user can send an SMS message via their Email client. All SMS Messages sent out via Email by Users who are not TMS Users will be recorded in the System Users Sent Messages Folder. Any TMS Administrator can 100
  • 101. monitor the System Users Sent Messages Folder to see all messages sent via Email Clients by non-TMS users. The TMS Server supports Collaboration Data Objects (CDO) as the technology used to integrate with the SMTP Gateway. The TMS Server is supported on Windows NT (SP6a), Windows 2000 and Windows XP. These Operating Systems use different versions of CDO and the TMS SMTP Gateway Services automatically determines which CDO library it should use depending upon the Operating System being used. In rare circumstances, it might be necessary to force the TMS SMTP Gateway to use a particular CDO Library. This is facilitated in the Email Gateway configuration tab in the TMS Server Configuration Control Panel Applet. 6.2.5 Removing Email Disclaimer Many organisations use a standard disclaimer at the bottom of each Email. In most cases these are automatically applied by the Email client. The Email Gateway Configuration option “Remove Disclaimer From E-mail Body” allows a standard disclaimer to be entered, so that when an Email to be sent as an SMS Message is received by the TMS Server, any disclaimer is automatically removed. For example the message To: tms.fred.smith@emailaddr.com Hi, is the meeting still scheduled for 2:00 pm tomorrow? Fred --------------------------------------------------------- Company Ltd. - Privacy, Security and Confidentiality Notice This e-mail and any attachments may contain confidential and privileged information. If you have received this e- mail in error please notify us immediately and delete it from your system. You must not copy, distribute, disclose or otherwise use any part of it. This email has been scanned by current virus software, however it is the responsibility of the recipient to ensure that this e- mail is virus free and no responsibility is accepted by Company Ltd. for any loss or damage arising in any way from receipt or use of it. Unencrypted electronic mail is not secure and may not be authentic. --------------------------------------------------------- Would be sent as: To: tms.fred.smith@emailaddr.com Hi, is the meeting still scheduled for 2:00 pm tomorrow? Fred Using this feature can reduce the cost of sending standard Email messages because the messages will contain far fewer characters. 101
  • 102. 6.3 File Processing File Processing allows files of standard formats to be sent as SMS Messages (Outbound Processing), or received SMS Messages to be dropped as formatted files into a folder (Inbound Processing). 6.3.1 Outbound Processing The TMS File Processor polls the Outbound folder for new files at a configurable rate (in seconds). Also, a maximum message size can be set. So for example, if the maximum message size is 800 characters then any files with messages over this limit will be automatically truncated. In certain circumstances, a company might wish to send SMS Messages from third party systems, such as a CRM system. TMS facilitates the sending of SMS Messages by allowing XML or Formatted Text files to be created using a certain format. 6.3.1.1 Formatted Text Files For example, imagine a third party system has 1000 contacts, each of which is required to send an SMS Message. If the CRM System can output files using the following format then they can be saved into the TMS File Processor Pickup folder, which will then be translated and sent as SMS Messages. Format: 07112223212;07223823321;tms.fred.smith@tms.com;0712232112 3, This is a reminder message to inform you that your Tax return is due to be received by us by 31/1/2003. The message above will be sent to four recipients. Note that one of the recipients is a TMS Friendly name, i.e. tms.fred.smith is a contact within the TMS Database. The File Processor will look up Fred Smith’s contact details to get the mobile number to send the message to. The “;” characters delimit each contact, and the “,” character indicates the end of the contacts and the start of the actual message. It is possible through the TMS File Processor configuration to change these delimiters to any other characters. By default, all messages sent via the file are allocated to the TMS System user’s outbox. To allocate the message to a specific TMS user, you can add the text <WHO:username> at the start of the line. Eg. <WHO:gary>07112223212;07223823321;tms.fred.smith@tms.com;0 7122321123, This is a reminder message to inform you that your Tax return is due to be received by us by 31/1/2003. The above message will be allocated to user “gary” and will be visible in their sent items. 102
  • 103. Multiple messages in a single file is now supported. To use this feature each request must start on a new line and the end of each message must have an <END> string. e.g. 0035386845xxxx ,Message 1 from TMS: Reminder <END> 0035386845xxxx ,Message 2 from TMS: Reminder <END> 0035386845xxxx ,Message 3 from TMS: Reminder <END> 0035386845xxxx ,Message 4 from TMS: Reminder <END> Using Microsoft Word, it would be possible to run a mail merge and save separate files into the TMS File Processor Pickup folder. For example: 07123123123, Dear Mrs Jones, This is a reminder that your dental appointment is next Monday, 10/2/2003. The mail merge fields are those shown in yellow. Running this, the mail merge could create separate files for each person who needs to see the dentist during the next four weeks. The File Processor would then pick up each file and send it to the SMS Message recipient. After a file has been successfully processed (i.e. the TMS Server has read the file and sent one or more SMS Messages to the recipients contained within the file) the TMS File Processor moves it from the “File Pickup Folder” to the “Processed Files Folder”. If an error occurs while translating the file, the TMS File Processor moves the file containing the problem from the “File Pickup Folder” to the “Error Files Folder”. 6.3.1.2 XML Processing Any file placed in the TMS File Processor Pickup directory with an extension of .xml (not case sensitive) will be processed by the XML parser. The XML file must conform to the following format (case sensitive): <SMSList> <SMS> <Who>pflynn</Who> <OutputResults>Y</OutputResults> <DeliveryNotify>Y</DeliveryNotify> <To> <Number>RECIPIENT1</Number> <Number> RECIPIENT2 </Number> </To> <Message>YOUR MESSAGE1</Message> 103
  • 104. </SMS> <SMS> <Who>pflynn</Who> <OutputResults>Y</OutputResults> <DeliveryNotify>Y</DeliveryNotify> <To> <Number>RECIPIENT1</Number> <Number> RECIPIENT2 </Number> </To> <Message>YOUR MESSAGE2</Message> </SMS> </SMSList> Note the <Who> field is optional within the file. Where defined, the value must match a TMS user account name. The SMS messages placed via files will be allocated to the specified users outbox. By default the sent text messages are allocated to the System user. 6.3.1.2.1 User Tags Integrators may also include their own XML tags within the file submitted to TMS. Custom tags can be added at any point in the structure. Eg. <SMSList> <MyFileInformation>xyz</MyFileInformation> <SMS> <MyReference>123456</MyReference> <OutputResults>Y</OutputResults> <DeliveryNotify>Y</DeliveryNotify> <To> <Number>RECIPIENT1</Number> <Number> RECIPIENT2 </Number> </To> <Message>YOUR MESSAGE1</Message> </SMS> </SMSList> All User Tag information is carried through to the output files. 6.3.1.2.2 Behaviour Tags The following are optional tags. <OutputResults>Y</OutputResults> <DeliveryNotify>Y</DeliveryNotify> If OutputResults is set to Y or Yes, the processed file will have a new node structure added into the XML (under the SMS node) providing details of the message id submitted to TMS. 104
  • 105. The format is as follows: <TMSFileProcessorResults> <SendMessage> <Mobile> RECIPIENT1</Mobile> <MessageId>56127</MessageId> </SendMessage> <SendMessage> <Mobile> RECIPIENT2</Mobile> <MessageId>56127</MessageId> </SendMessage> </TMSFileProcessorResults> Please note that a SendMessage block will only be added for recipients that have been successfully validated. If, for example, a message was destined for ten recipients of which one number was invalid then only nine SendMessage blocks will be recorded in the processed file. If DeliveryNotify is set to Y or Yes, the SMS will be requested with Delivery Notification. If a delivery notification is specified, sent and delivered XML files will be written to the Drop Directory specified in the File Processing tab of the TMS control panel applet. All Delivery Notification files will start with SMSUPDATE- in their filename. The format of the DeliveryNotify message is as follows: <SMSStatusUpdate> <MessageId>56139</MessageId> <Status>DELIVERED</Status> </SMSStatusUpdate> Where <MessageId> ties back to the <SendMessage><MessageId>. The status can be FAILED, SENT or DELIVERED. Note: The message text must be valid XML. This means that characters such as & < > which have meaning with XML must be properly expressed as shown below. &lt; < less than &gt; > greater than &amp; & ampersand &apos; ' Apostrophe &quot; " quotation mark Where a message contains many of these characters (or if preferred), the message text can be encapsulated by a CDATA section which effectively stops any XML parsing of the message text. Examples are show below: <Message>hello from him &amp; me </Message> 105
  • 106. message is “hello from him & me” <Message><![CDATA[hello & how are you]]></Message> message is “hello & how are you” <Message><![CDATA[put your message between these square brackets]]></Message> -> message is “put your message between these square brackets” Note: Each <SMS> section corresponds to a separate text message. You may send as many Text messages as you require from a single file. Only one <Message> node per <SMS> record is allowed. The text in the message can contain line feeds. You may specify as many <Number> records as required. The <Message> will be sent to each <Number> The Value for RECIPIENTx can be one of: A local mobile phone number (i.e. 0780 1000000) An International formatted mobile phone number ( i.e. +44780 1000000, 0044 780 1000000) A TMS Contact Name. This is specified by the pattern TMS.firstname.lastname A TMS Contact Group. This is specified by the pattern TMS.groupname. (Note: This will result in the message being sent to each of the contacts in the Group) 6.3.1.2.3 Example <SMSList> <SMS> <To> <Number>0780108999</Number> </To> <Message>I will meet you at 5:30 at the station.</Message> </SMS> <SMS> <OutputResults>Y</OutputResults> <DeliveryNotify>Y</DeliveryNotify> <To> <Number>TMS.gary.shacklock</Number> <Number> TMS.paul.flynn </Number> </To> <Message>Sorry Gary &amp; Paul, I cant make the meeting </Message> </SMS> <SMS> <OutputResults>N</OutputResults> <DeliveryNotify>N</DeliveryNotify> 106
  • 107. <To> <Number>TMS.allsales</Number> <Number>+44780108999 </Number> </To> <Message><![CDATA[All, We have had a great year & have met all our targets. Please keep up the good work]]></Message> </SMS> </SMSList> 6.3.1.2.4 Error Handling Normally a file will be processed without errors. In this scenario the xml file will be moved into the processed directory. If an error occurs, such as the file is invalid or one of the <SMS> records is badly formatted, an error file will be created in the Error folder. You should check the Error folder to ensure that your SMS messages are being sent. When error files are created they are given a File extension that describes the problem. File Extension Description XML_ERROR The XML file was not valid. Either the XML structure has not been adhered to, an XML element has not been specified correctly (Remember XML is case sensitive) or characters such as < > & have been used without encapsulation . The file should be corrected and copied back to the Pickup Folder. INVALID_NUMBER The mobile number specified is not a valid format (too short or long or non- numeric characters have been found) INVALID_CONTACT A TMS contact name has been specified, but the contact was not found in the database INVALID_GROUP A TMS group name has been specified, but the contact was not found in the database BLANK_MESSAGE The <Message> entity is missing or a blank message has been supplied BLOCKED_NUMBER An SMS could not be processed as the recipient number is not allowed (e.g international or short code) 107
  • 108. For all of the INVALID_* errors, the error file will contain details of the message and recipient that could not be processed. E.G INVALID_NUMBER 0656565567801076111,This was the message being sent – the number is too long 108
  • 109. 6.3.2 Inbound Processing The TMS File Processor supports the concept of Inbound SMS Message Processing. If this facility is enabled by a TMS Administrator, any SMS Messages received by the TMS Server will automatically be written to the Inbound Drop Folder. It is then the responsibility of a third party application to monitor the Inbound Drop Folder for new messages to process. It is also the TMS Administrator’s responsibility to perform housekeeping on the TMS Inbound Folder. Note: TMS V7 defaults inbound messages be stored in XML format. If the previous recording format (<Originating Number>,<Message Text>) is required you can enable this by adding the registry key HKEY_LOCAL_MACHINE->Software- >DevHQ->FileProcessor->OutputNonXML as a String value and giving this the value of 1 A new XML file will be created (with unique name) for each received SMS. The XML format will be as follows: <InboundSMS> <From> SENDER </From> <Message> <![CDATA[TEXT OF MESSAGE]]</Message> </InboundSMS> SENDER:= mobile number of the SMS originator. Note: The CDATA section is used by default to disable XML parsing of the message text, as this may contain invalid XML characters (see table below). &lt; < less than &gt; > greater than &amp; & ampersand &apos; ' Apostrophe &quot; " quotation mark 109
  • 110. 7 TMS Client Components 7.1 TMS Client This section describes the features of the TMS Client. 7.1.1 Server Connectivity Three different security models are provided, allowing a system administrator to choose which is the most convenient to allow users to access the TMS Client software. TMS Security – this security method allows users created by the TMS Administrator to log into TMS Server. Each time a user runs the TMS Client application they are prompted to enter their TMS Username and Password. Active Directory/Domain Security – this security method allows Users to log into TMS Server using their current Windows Credentials. The TMS Administrator can also allow only Users belonging to certain AD/Domain Groups to access the TMS Server. TMS Administrators can also separate TMS Administrators and TMS Users by allocating Users to a TMS Administrator Group or a TMS User Group. In this mode, TMS Users will not be able to specify their logon details, as their OS Login details will be passed through. 110
  • 111. RightFax Security – this security method allows TMS Users to log into the TMS Server using their RightFax User settings. Using RightFax Security, RightFax users can log into TMS. Users who have RightFax Administration privileges will also be given TMS Administration privileges. 7.1.2 Main Application Window Modes Depending upon the current activity of the User, the TMS Client will display itself in a certain mode (context). 7.1.2.1 Message Mode Context To set the TMS Client into Message Mode Context, the User Inbox or User Sent icons should be selected in the treeview: In this mode, the user can see received messages and sent messages. From this mode, the user can: • View all received messages • View all sent messages • Create a new message • Delete a message • Forward a message • Reply to a message • Resend a message 111
  • 112. 7.1.2.2 Contacts Mode Context To set the TMS Client into Contacts Mode Context, the Global Contacts or Local Contacts icon in the treeview should be selected: In the Contacts Mode Context, users can administrate Global Contacts (if they are a TMS Administrator) and Local Contacts. The following Contact operations can be performed: • View all Global Contacts and Contact Groups • View all Local Contacts and Contact Groups • Create Local Contact • Modify Local Contact • Create Local Contact Group • Modify Local Contact Group • Delete Contact • Create Global Contact • Modify Global Contact • Create Global Contact Group • Modify Global Contact Group 112
  • 113. 7.1.2.3 System Mode Context To set the TMS Client into System Mode Context, the System Inbox or System Sent icon in the treeview should be selected: In this mode, the User can see received messages and sent messages. From this mode, the User can: • Allocate a message received into the system inbox to a user • View messages received into the system inbox • View messages sent from the System User (i.e. messages sent by e-mail clients where the user sending the e-mail is not a registered TMS User. • Create a new message • Delete a message • Forward a message • Reply to a message • Resend a message 7.1.2.4 User Mode Context To set the TMS Client into User Mode Context, the User icon in the treeview should be selected: Only TMS Administrators can see this mode. In this mode the user can see all the current TMS Users and the following operations can be performed: • Add user • Modify user • Delete user 113
  • 114. 7.1.3 TMS Client Icons Explained The main application window consists of a menu, toolbar, treeview and item list. The treeview shows the user’s Inbox, Sent Messages, Global and Local Contact lists. If the logged in user is a TMS Administrator, they will also see the System Inbox and Sent folder and node for each user. Create a new message. Clicking this icon brings up the Send Message dialog where the user can write and send a new SMS Message. Open message. Clicking this icon opens the currently selected Message. Forward message. Clicking this icon will open the Send Message dialog so the user can forward the message to a new recipient. Resend message. Clicking this icon will open the Send Message dialog so the user can resend the message to the same recipient as the original message. Delete message. Clicking this icon will allow the user to delete the currently selected message. A warning dialog is presented to make sure that the user wants to delete the message. User Inbox. Clicking this icon shows all the received messages in the right hand pane. User Sent Messages. Clicking this icon shows all the messages sent by the user in the right hand pane. Global Contacts. Clicking this icon shows all global contacts defined in the TMS System. Contacts can be individual or groups of contacts. Local Contacts. Clicking this icon shows all local contacts and contact groups defined by the logged in User. System Inbox. Clicking this icon shows all the messages sent to the system user account. System messages are any messages that could not be automatically routed to a particular TMS User. It is the administrator’s responsibility to route these messages to the correct TMS User. Sent Inbox. Clicking this icon shows all the messages sent by the System user. User Details. Clicking on a User icon shows the Users Inbox and Sent Messages. It also allows the System Administrator to modify any details of the selected user. 114
  • 115. Each message can have a particular status. The following list describes each status type. The status is shown in the right hand message view window in the main TMS Client. Message has been received but not viewed by the user. Message is currently sending. Message is pending to be sent. Message has been opened by the user. Message has been sent successfully. Message was not sent successfully. Message delivery notification has been received. 7.1.4 Sending and Receiving Messages From the TMS Client Application, Users can send new messages, reply to received messages, forward previously sent messages and resend previously sent messages. The TMS Administrator can set the maximum message size – by default it is 1600 characters, which is 10 SMS messages. The status bar shows the current message size, and how many SMS messages are required to send the message. 115
  • 116. If a large SMS Mail Shot is required, and the contacts are not contained in the TMS Contacts database, the message can be sent via the Import button. The import button opens a “File Open” dialog, asking the user to specify an ASCII Text file containing a list of mobile phone numbers to send the message to. The format of the ASCII Text File should consist of one mobile telephone number per line, for example: 7.1.5 Create a New SMS Message Using the TMS Client, it is very simple to send an SMS Message, using the Send Message Toolbar Button, or the New… menu item from the Messages menu. The Toolbar at the top has three buttons, Send, Recipients and Options. Pressing the Send Button sends the SMS Message. Before a message can be sent, message recipients have to be added. Pressing the Recipients Button brings up the Contacts Screen, allowing the user to easily select existing TMS Contacts. Pressing the Options Button allows the user to specify if they want a Delivery Notification and further options to have the message sent at a later date/time. Add – this button adds a manually entered SMS number, or Contact Name to be added to the list of message recipients. To – this button brings up the Contacts Screen, allowing the user to easily select existing TMS Contacts. Del – this button deletes the selected user from the list of recipients. Import – this button allows the user to import a list of external contacts using a csv file. 116
  • 117. 7.1.6 Select Contacts The Select Contacts screen allows users to select a contact or group of contacts as the recipients of an SMS Message. 7.1.7 Send Options The Send Options dialog allows users to specify if they require a delivery notification and when they want the SMS message to be sent. By default, the new message will be sent immediately and with delivery notification turned off. 117
  • 118. 7.1.8 Signatures A Signature is a standard piece of text attached to the end of each SMS message. Each TMS User can create one or more standard signatures. To add a signature, type some text in the edit box and press the Add button. The signature will then be added into the list of common signatures for that user. After the signature has been created, the user can then select it in the Send Message dialog from the Signature list. To send a signature the Signature check box should be ticked. 7.1.9 Setting up Contacts Two types of contact can be setup in TMS. Administrators can set up global contacts and groups. Normal Users can set up their own local contacts and groups. TMS Client allows contacts and contact groups to be created, modified and deleted. 7.1.10TMS Contacts Add Contacts. Pressing this icon allows the User to create a contact. If the logged on user is a TMS Administrator, then the new contact can be marked as Global, meaning that it will be visible to all TMS Users. Add Local Group. Selecting this icon allows the user to create a group of local contacts. Add Global Group. Selecting this icon allows the User to create a global group of contacts. This icon is only displayed if the logged on user is a TMS Administrator. Modify Contact. Selecting this icon allows the user to edit the currently selected contact. Modify Group. Selecting this icon allows the user to edit the contacts in the currently selected contact group. 118
  • 119. 7.1.11Create a Local Contact Each contact consists of a First Name, Last Name, Mobile Number and E-Mail Address. If the logged in user is a TMS Administrator, the Global tick box is available, meaning that the Contact will be created as a Global Contact, available to all TMS Users. 7.1.12Create a Group of Local Contacts To create a Contact Group, the user needs to select the Contacts button to select the contacts they require. Once selected they will appear in the Add Group contact list pane. 119
  • 120. Once all the contacts have been added to the Local Contact group, the user needs to give the Contact Group a name. When finished, the OK button will then save the new local contact group. 120
  • 121. 7.1.13Inbound SMS To Contact List The Inbound SMS to contact list feature allows contacts to be added to a group by texting into the system and being added to an already created Group based on the group name and keyword being placed in the incoming message. For example, the group name is Football_Results and the Group Add Keyword is START, So the incoming text would be Football_Results START To Create Inbound Contacts Automatically to a Contact List Group, Select Show Advanced Settings. 121
  • 122. Allow new Contacts via message request.-This will allow contacts to be added to the group. Send successfully opted in message -A customised automated message sent to the originator of the inbound request to confirm they have opted in. Send successfully opted out message - A customised automated message sent to the originator of the inbound request to confirm they have opted out. Group Add Keyword – Keyword value used alongside the group name to opt into the contact group list. Group Remove Keyword - Keyword value used alongside the group name to opt out of the contact group list. 122
  • 123. Alongside the Advanced settings of the Contact Group list, the user properties must have the Allow Contact Group Updates option selected within the TMS user properties 123
  • 124. 7.1.14Modify Contact The Modify Contact dialog allows the user to change the details of an existing Contact. Only TMS Administrators can modify Global Contact details. 7.1.15The System User The System User stores messages that could not be automatically routed to a TMS User. For example, if an SMS Message is received, and it was not destined for a particular user, it will be stored in the System Users Inbox. Only TMS Administrators have access to the System User Inbox. Using the Allocate Message dialog, the TMS Administrator can allocate the selected message to any TMS User. 7.1.16Importing Contacts The Import Contacts dialog allows a user to Import Contacts into TMS. If the logged- in user is a TMS Administrator, the Global check box is enabled, allowing Global Contacts to be imported. 124
  • 125. The import file type is csv (comma separated values). The format of the file is (per line): User First Name, User Last Name, Mobile Number, E-Mail Address 125
  • 126. 7.1.17Importing Users Note: This facility is only available when using TMS Native Security. If the logged in user is a TMS Administrator, they may create bulk user accounts from a text file. The file format must conform to the following format (one line per record): Logon Name, User Full Name, User Short Name, Mobile Number Email Address, DDI Number, Allow SMTP Mail, Route To Email, Route To Mobile, Use Own Number, User Group Id, Administrator Field Description Logon Name Unique TMS account name. User Full Name Full Name of the user. User Short Name User Alias used for short name routing. Mobile Number User’s Mobile Number or Blank. Email Address Must be set to the users corporate email address. DDI Number Set to the user’s allocated DDI number or leave blank if the user doesn’t have their own unique DDI number. Allow SMTP Mail If Set to 1, users can send emails from their own mobile phone by using special tokens in the text message. The email will appear as sent from their corporate email system. Route To Email If set to 1, any inbound SMS messages will be forwarded to the user as an email. Route To Mobile If set to 1, any inbound SMS messages will be forwarded to the user’s own mobile. Use Own Number If set to 1, outbound SMS messages will be sent with the user’s own mobile number. User Group Id The Id of the Group to which the user belongs. Administrator Set to 1 if user should be a Administrator, otherwise set to 0. 126
  • 127. E.g. gshacklock,Gary Shacklock,GS,07801076999,gshacklock@email.com,44123123,1,1,1,1,1,1 7.1.18Creating New Users The Add User dialog allows TMS Administrators to create new TMS Users. 127
  • 128. • User Name – this field is the name to be used by the user to log into TMS. • Password – this field is the password used by the user to log into TMS. • Short Name – this field is the name used for routeing SMS messages to the user • Full Name – user’s full name. • User Group – the User Group the user is to be associated to. User Groups are used for Reporting purposes, i.e. a report showing how many international messages were send from a particular group. • Administrator – indicates whether the user shall be an administrator or not. • DDI Number - dedicated MSISDN number associated to a user (similar to a telephone extension). • Allow Contact Group Updates – if a message is received into the user’s TMS Inbox and the message has been sent using the correct format as specified in the user’s Advanced Group Contacts option, then the originator’s mobile details of the inbound message will automatically be entered in the corresponding Group contact list. • Route To Mobile – when an incoming message is received by the user, it will automatically be sent out to the mobile number given. 128
  • 129. • Use Own Number – if messages are being sent via the IP solution rather than the GSM solution, then selecting Use Own Number will ensure that any return messages are sent directly to the number specified in the Route To Mobile edit box. • Enable Mobile Emailing – if enabled, allows users to send SMS Messages as E-mails, as if it originated from their Email client. • Route To Email – send your received SMS Messages to a designated e-mail address. • Automated Reply – if enabled, the text specified in the box below will be returned to a mobile user that sends a text message in to this TMS Users account. This can be used as an out of office notification. 129
  • 130. 7.1.19Modify User Details Only TMS Administrators can modify other user’s details. All users can modify their own details using the menu File->My Properties dialog. • User Name – name used by the user to log into TMS. • Password – press the reset button to reset a user’s password. • Short Name – short Name is used by the routeing options (please see below). For example if an SMS is received with the word <username> it will be directed to the username inbox. • Full Name – user’s full name. • User Group – the User Group the user is to be associated to. User Groups are used for Reporting purposes, i.e. a report showing how many international messages were sent from a particular group. • Administrator – indicates whether the user shall be an administrator or not. • DDI Number - dedicated MSISDN number associated to a user (similar to a telephone extension). 130
  • 131. • Allow Contact Group Updates – if a message is received into the user’s TMS Inbox and the message has been sent in using the correct format as specified in the user’s Advanced Group Contacts option, then the originator’s mobile details of the inbound message will automatically be entered in the corresponding Group contact list. • Route To Mobile – when an incoming message is received by the user, it will automatically be sent out to the mobile number given. • Enable Mobile Emailing – if enabled, allows users to send SMS Messages as E-mails, as if it originated from their Email client. • Use Own Number – if messages are being sent via the IP solution rather than the GSM solution, then selecting Use Own Number will ensure that any return messages are sent directly to the number specified in the Route To Mobile edit box. • Route To Email – send your received SMS messages to a designated e-mail address. • Automated Reply – if enabled, the text specified in the box below will be returned to a mobile user that sends a text message into this TMS User’s account. This can be used as an out-of-office notification. 131
  • 132. 7.1.20Delete a User Only TMS Administrators can Delete Users. Once a user has been deleted, all their associated local contact data is also be removed from the database. Their messages will be retained and can be removed using the TMS Purge Application. 7.1.21Create a New User Group Only TMS Administrators can create a new user group. • Group Name – Name of the new User Group. • Cost Centre – Name of the cost centre associated to the User Group. 7.1.22Modify a User Group Only TMS Administrators can modify a User Group • Group Name – Name of the new User Group. • Cost Centre – Name of the cost centre associated to the User Group. 132
  • 133. 7.1.23 Delete a User Group Only TMS Administrators can delete a User Group. All users allocated to the group must first be reallocated or deleted. Select the group to be deleted and press OK. 133
  • 134. 7.1.24Modify Call Charges Only TMS Administrators can change the Call Charge Settings. Call charges can be set for national and international calls. The National Call Prefixes edit box allows the National Call Prefixes to be changed. Each national Call prefix should be separated by a comma. 134
  • 135. 7.2 TMS Outlook Client Using Microsoft Outlook, users can install and run the TMS Outlook Client Add In. This allows users to select the contacts they wish to send an SMS message. When the user first runs the TMS Outlook Client, they are prompted to enter the Server Name and re-open the TMS Outlook Client. Once the server name has been set, and the TMS Outlook Client Restarted, all TMS Contacts will be shown in the “Select TMS Contacts” window. 135
  • 136. The TMS Outlook Client add-in allows users to select from five different categories of contact: • TMS - the TMS Address Source provides a list of all TMS Global Contacts and Contact Groups. • Outlook Contacts – this address source fetches all Outlook Contacts who have mobile phone numbers associated to them. • Global Phonebook – this address source fetches all global contacts from the Microsoft Exchange server. • Personal Phonebook – this address source fetches all personal contacts from the Microsoft Exchange server. • Public Folder Hierarchy – the exchange public folder structure can be expanded and contacts with a registered mobile number can be selected as SMS recipients. After you have selected the contacts and pressed the OK button, your contacts will appear in the “To” edit box so all the user has to do is type the message and press the “Send” button. Microsoft has added an extra security patch to stop viruses such as the “LOVE BUG” from sending bogus e-mail messages. This patch might cause the following window to appear when selecting the Outlook Contacts Address Source: 136
  • 137. If this message is shown then make sure the “Allow access for” 1 minute is checked and then press the “Allow” or “Yes” button. 7.2.1 E-Mail Validation Errors The following e-mail messages can be sent back to the user due to an e-mail address validation error: • If the e-mail address did not contain a valid SMS Number. For example, this can happen if the e-mail was sent using 0780XXXYYY@TMS.COM as the e-mail address. • If the e-mail address failed to contain a valid Contact Group name. For example, this can happen if the e-mail was sent using TMS.ACCOUNTS@TMS.COM as the e-mail address and the Contact Group name ACCOUNTS is not a valid TMS Group. • If the e-mail address contained a Contact Name that does not exist in the TMS database. For example, this can happen if the e-mail was sent using TMS.GRANT.SMITH@TMS.COM where the contact “Grant Smith” is not a valid TMS Contact. • If the e-mail address contained an invalid SMS Number, i.e. too long or too short. For example, this can happen if the e-mail was sent to +44728238281828392@TMS.COM where the number is a bad length (i.e. in this case it is too long). • If the e-mail did not contain any Subject or Body content. For example, this can happen if the message does not contain any content in the Subject line or the e-mail body. 7.2.2 E-Mail Access Errors The following E-Mail Access errors can occur due to the following circumstances. • If the Restrict Flag is set in the E-mail Gateway Configuration and you are not a valid TMS User, all your outgoing SMS messages will be rejected and an e-mail will be returned explaining that the sender is not a valid TMS User. • If there are more users trying to send messages than the licensed number of users, then the outgoing e-mail message will be rejected, and e-mail will be returned to the sender explaining that the User Licence limit has been exceeded. 7.2.3 E-Mail Notification Messages You will receive notification e-mail messages in the following circumstances. 137
  • 138. • If your SMS message has been successfully sent. • If your SMS message has been successfully delivered to the recipient. 138
  • 139. 7.3 TMS Reports 7.3.1 Overview For TMS V7 a new reporting system has been created that provides summary and detail reports for both outbound and inbound messaging. The summary reports include graphical dashboards that show the current usage/trends over standard reporting periods, billing reports that show cost breakdowns by users and departments, volume based reports showing your national and international messaging grouped into various categories. The detail reports allow you to identify which users are sending to specific numbers or provide a breakdown of messages by user or recipient or to track inbound message traffic. In total there are 21 predefined reports and new reports can be easily created either by Avanquest or by the client. (The Reports are designed via VS2005 which is a free-of-charge component on SQL Server installations). Alternatively contact Avanquest-ProcessFlows for a quote on designing reports to suit your needs. The Report Viewer application can be installed on any PC that has the TMS Client installed. A command line interface allows reports to be scheduled for creation via the Scheduled Task facility of the Microsoft Windows® operating system. The reporting system is based on Microsoft SQL Reporting services and a full set of report RDL files are included in the release. These can be imported into an existing or new SQL Reporting server. 139
  • 140. 7.3.2 TMS Reports Application Report Data Files The TMS Reporting System makes use of the following data/configuration files : TMSReports.exe.config / ReportExport.exe.config These are the main application configuration files for the Report Viewer and Report Export applications respectively. They contain important configuration information such as the connection string for access to the TMS database, and the locations of various data files. These files are located in the folders into which the respective applications are installed. Each configuration item is specified in XML format, i.e. <add key="name of Item" value="value of item"/> The following table describes the main configuration values. NB: These values are common to both applications Item Name Item Value ReportsConnectionString Connection string to the TMS SQL Server Database. ReportListFile Full path to the Report List file. This file is described below. ReportDefinitionPath Full path to the folder containing the Report Definition and Control files (.rdlc and .control files – see below) DeviceInfoPath Full path to the folder containing the Device Information files (described below) ReportExportPath Full path to the folder where Report data will be exported. Note that in a typical installation, only the ReportsConnectionString value will need to be edited. Report List File This file contains a list of all reports which can be viewed/exported. It is an XML file of the following format : <?xml version="1.0" encoding="utf-8"?> <Reports> <Report Name="report #1 name" Title="report #1 title" /> <Report Name="report #2 name" Title="report #2 title" /> <Report Name="report #3 name" Title="report #3 title" /> … 140
  • 141. … </Reports> Report Definition Files Each report is defined by its Report Definition file. This is a text file with the extension .rdlc and is written using the Microsoft Report Definition language. These files are used directly by the TMS Report applications, but if required, can be installed in a Microsoft SQL Reporting Services environment. Each Report Definition file is named : <report name>.rdlc Report Control Files Each Report has an associated Control file. This information is only used by the Report Viewer application. Each Control file determines the positioning of the Report parameters within the parameters section of the Report Viewer. If the Report has no input parameters, no control file is needed. Each Control file is named : <report name>.control These files are formatted as follows :- <?xml version="1.0" encoding="utf-8"?> <Controls> <Control Name="p_start" Top = "30" Left = "10" Width = "92" LabelWidth = "65" Option = "0"/> <Control Name="p_end" Top = "60" Left = "10" Width = "92" LabelWidth = "65" Option = "0"/> </Controls> The Option value is used if the parameter is a DateTime value, and determines whether or not the parameter will specify both date and time (Option = "1") or just date (Option = "0"). Device Information Files The Device Information files contain information used to correctly format the Report exports. There are two default Device information files : • Image.xml - this file determines the default height, width and output format of Image export files. The file is formatted as follows : <?xml version="1.0" encoding="utf-8"?> 141
  • 142. <DeviceInfo> <OutputFormat>TIFF</OutputFormat> <PageHeight>8.5in</PageHeight> <PageWidth>17in</PageWidth> </DeviceInfo> - the OutputFormat can be TIFF, JPEG, GIF or BMP • PDF.xml - this file determines the default height and width of PDF export files. The file is formatted as follows :- <?xml version="1.0" encoding="utf-8"?> <DeviceInfo> <PageHeight>8.5in</PageHeight> <PageWidth>17in</PageWidth> </DeviceInfo> In addition to the default files, the settings can be overridden for any individual report by using one of the following files : Image_<report name>.xml, PDF_<report name>.xml Report Export Report Export is a command line application which enables reports to be generated in one of the following formats : • PDF • Excel • Image (TIFF, JPEG, GIF or BMP depending on the Device Information File) The application can be run manually from the command line, or run on a scheduled basis via the Windows Task Scheduler. Command Line Arguments The Report Export application requires the following command line arguments, which must be specified in order : 142
  • 143. Param Value Description # 1 <reportName Name of report to export. This > report must be one of the reports listed in the Report List file, and must have a corresponding Report Definition file. 2 <format> Either PDF, Excel or Image 3 <filePostfix> This text is appended to the name of the report export file, and can be used to distinguish certain types of report, e.g. DAY or WEEK. If no postfix is required, the placeholder “” must be used (i.e two adjacent double-quote characters). 4 Report The 1st report parameter Parameter #1 (optional) – see below 5 Report The 2nd report parameter Parameter #2 (optional) – see below … ... … Report Parameters are specified as follows :- <prefix>:<value> (NB: The : is required. Value must appear immediately after the : ) type prefix value Text T Any characters except ‘ (single quote). If text contains spaces, enclose in double quotes “ “ e.g. T:hello T:”hello world” Int I Any valid integer e.g. I:5 Float F Any valid floating point number e.g. F:1.234 Boolean B Any of the following:- t, true, 1 (all values = true), f, false, 0 (all values = false) e.g. B:true Date D DateTime value. Must be of the format <date>T<time> <date> YYYY-MM-DD or can be one of the following special values :- YESTERDAY, TODAY, TOMORROW, SUNDAY, MONDAY, TUESDAY, etc… <time> HH:MM:SS or can be the special value :- NOW e.g. D:MONDAYT08:00:00 D:TODAYTNOW D:2008-07-18T09:27 143
  • 144. Export Path Report data files are created with the following path : <ReportExportPath><todays date><report name>-<filePostfix>.<extension> Where : <ReportExportPath> - value defined in the application configuration file <todays date> - in format yyyy-MM-dd (e.g. 2008-09-20) <report name>- name of report (specified in command line) <filePostfix> - value specified in command line <extension> - one of pdf, xls, tif, jpg, gif Scheduling Reports Report exports can be can be produced on a scheduled basis, using the Windows Task Scheduler. The first step is to create a batch file (or files) containing the required ReportExport command lines. The batch file(s) can then be added to the list of scheduled jobs. 144
  • 145. Report Viewer The Report Viewer application enables report data to be viewed. All required reports must be in the ReportList file, and must have corresponding Report Definition Files. To view a report : • Select the required report from the list. • Specify the required parameters. • Click on “Show Report” To export a report : • Select the required report from the list. • Specify the required parameters. • Click on “Show Report” • Select the required export format from the list • Click on “Export” 145
  • 146. 7.3.1 Stock Reports This section describes each of the stock reports provided with TMS. If the optional Report Designer has been purchased, you can create additional reports or modify the existing set. Customers may also request Avanquest to develop reports on their behalf at additional cost. Following successful logon, the Report Viewer application will be displayed: 7.3.1.1 100 - Summary - All Users (Inbound & Outbound) This report lists users that have sent or received SMS messages during the reporting period. Users are listed alphabetically. Separate counts are shown for International SMS (which are more expensive). 146
  • 147. 7.3.1.2 110 - Summary - Users By Group (Inbound & Outbound) This report shows User SMS usage, broken down at Department level (TMS Group). Totals are displayed for each group. . 147
  • 148. 7.3.1.3 120 - Summary - Group Totals (Inbound & Outbound) This report provides a simple Department (TMS Group) summary of usage during the reporting period. 148
  • 149. 7.3.1.4 130 - Summary - Billing By User Lists users alphabetically, showing the total cost of their SMS usage in the reporting period. 149
  • 150. 7.3.1.5 140 - Summary - Billing By Group And User This report is similar to report 130, but adds grouping of Departments (TMS Groups), to show cost breakdown to cost centres. 150
  • 151. 7.3.1.6 150 - Summary - Billing By Group Provides a summary of departmental costs of SMS usage during the reporting period. 151
  • 152. 7.3.1.7 155 - Summary - Billing By Specific Group As per Report 150, but allows the user to specify a particular Group. 152
  • 153. 7.3.1.8 160 - Summary - Failed Outbound SMS This report details any outbound SMS messages that failed to send. Failures are typically down to invalid mobile numbers being specified. The report also lists any messages that are still pending transmission after two hours. 153
  • 154. 7.3.1.9 170- Summary - SMS Volume By TMS Application This report shows how the various TMS components are being used in the organisation, by breaking down sent messages into the application categories. 154
  • 155. 7.3.1.10 200 - Outbound to Specific Number Reports on SMS messages set to a specific number. You may use the % wildcard when specifying the OutboundNumber parameter. 155
  • 156. 7.3.1.11 210 - Outbound (Most popular Numbers) Report to show the most popular mobile numbers that messages are being sent to. 156
  • 157. 7.3.1.12 220 - Outbound to Premium Numbers (shortcode) Lists all SMS messages sent to mobile numbers that are less than 11 digits. 157
  • 158. 7.3.1.13 300 - Inbound from Specific Number Details SMS Messages received from a mobile or DDI number. 158
  • 159. 7.3.1.14 310 - Inbound (Most Popular Numbers) Reports an ordered list of received volumes from mobile phones and DDI numbers. 159
  • 160. 7.3.1.15 400 - Detail - Inbound SMS (All) Reports detail on all received SMS messages in the reporting period. 160
  • 161. 7.3.1.16 410 - Detail - Inbound SMS By User Reports the details on received messages grouped by the TMS User that the SMS was allocated to. 161
  • 162. 7.3.1.17 420 - Detail - Inbound SMS By Sender Reports the detail of messages grouped by the sending number. 162
  • 163. 7.3.1.18 500 - Detail - Outbound SMS (All) Reports the detail of each SMS message sent during the reporting period, including the delivery status. 163
  • 164. 7.3.1.19 510 - Detail - Outbound SMS By User As Report 500, but includes grouping back to the sending user. 164
  • 165. 7.3.1.20 910 - 24 Hour Dashboard This dashboard shows TMS activity over the last 24 hours. Separate charts are used to show: • Outbound (by status) showing totals for messages that have been delivered, have failed or are still pending. This provides a quick summary of recent usage. 165
  • 166. 7.3.1.21 911 – Outbound in Last 24 Hours by Application Reports the total number of SMS messages sent during the last 24 hours by application. 166
  • 167. 7.3.1.22 912 –Non-International Outbound in Last 24 Hours By Group Reports the total number of Non-International SMS messages sent during the last 24 hours by group. 167
  • 168. 7.3.1.23 913 – International Outbound in Last 24 Hours By Group Reports the total number of International Outbound SMS messages sent during the last 24 hours by group. 168
  • 169. 7.3.1.24 915 – Inbound in Last 24 Hours By Group Reports the total number of Inbound SMS messages during the last 24 hours by group. # 169
  • 170. 7.3.1.25 920 – Outbound in Last 7 Days By Status As per Report 910 but covering the last 7 days. 170
  • 171. 7.3.1.26 921 – Outbound in Last 7 Days By Application Total number of message sent in the last 7 days by application. 171
  • 172. 7.3.1.27 922 – Non-International Outbound in Last 7 Days By Group Reports the total number of Non-International Outbound SMS messages sent during the last 24 hours by group. 172
  • 173. 7.3.1.28 923 – International Outbound in Last 7 Days By Group Reports the International Outbound messages in last 7 days by group. 173
  • 174. 7.3.1.29 924 –Outbound in Last 7 Days Costs By Group Reports the total Outbound messages in last 7 days costs by group 174
  • 175. 7.3.1.30 925 – Inbound in the Last 7 Days By Group Reports the total Inbound messages in the last 7 days by group. 175
  • 176. 7.3.1.31 930 – Outbound (by Status) Reports the total number of Outbound messages in last 30 days by status. 176
  • 177. 7.3.1.32 931 – Outbound in Last 30 Days By Application Reports the total number of Outbound message in last 30 days by application. 177
  • 178. 7.3.1.33 932 – Non-International Outbound in Last 30 Days By Group Reports the total of Non-International Outbound messages in last 30 days by group. 178
  • 179. 7.3.1.34 933 – International Outbound in Last 30 Days By Group Reports total International Outbound messages in last 30 days by group. 179
  • 180. 7.3.1.35 934 – Outbound in Last 30 Days Costs By Group Reports total of Outbound messages in last 30 days by cost and group. 180
  • 181. 7.3.1.36 935 – Inbound in Last 30 Days By Group Reports total number of Inbound messages in last 30 days by group. 181
  • 182. 8 Developer Integration TMS offers a number of solutions for developers wishing to integrate SMS functionality into their applications. This section briefly highlights the available options. 8.1 XML File Interchange interface The TMS File processor supports bi-directional SMS capability through the exchange of XML files. For developers looking for a loosely coupled solution, this mechanism is a good choice. The XML file interface is extremely useful for customers wishing to mailshot messages to large number of recipients. Further information is available in document TMS File Processor - XML Processor.doc. If you don’t already have this document, you can request it through your TMS supplier. 8.2 Webservices The TMS Webservices are SOAP compliant, developed using Microsoft .Net 2. Webservices have been exposed to enable Application developers to : • send SMS Messages • track SMS Delivery (or failure) • receive SMS from mobiles The webservice calls have TMS authentication built-in. The webservices reference guide is available in document TMS Webservices Reference Guide.rtf. This guide includes the necessary information to build your client proxy from the exposed WSDL. A test website is included with the webservices installation. 8.3 COM API A COM API is also available for developers using Microsoft VB and C++ development environments (or any other supporting technology). This API is fully remotable being delivered as an OOP Server and client proxy. The API provides authentication and bi-directional SMS services. A reference guide is available in document TMS API COM Reference Guide.rtf . 182
  • 183. 9 Technical Support Please contact Avanquest UK for support and after sales service. 9.1 Postal Address Avanquest UK Limited 40-43 Jewry Street Winchester Hampshire SO23 8RY 9.2 Web Address www.processflows.co.uk 9.3 Support E-mail: support@ processflows.co.uk Telephone: +44 (0) 1962 835001 Fax: +44 (0) 1962 835101 9.4 Sales E-mail: sales@ processflows.co.uk Telephone: +44 (0) 1962 835053 Fax: +44 (0) 1962 835100 183
  • 184. 10 TMS Manager 10.1 TMS Manager This section describes the features of the TMS Manager. 10.1.1TMS Manager Summary This service is configured to start up automatically and is not managed through the TMS Control Panel Applet. The service may be started and stopped manually via the NET START TMSMANAGER & NET STOP TMSMANAGER DOS commands. The TMS Manager Service monitors the TMS, SMTP, File Processor and License Manager services and identifies situations where the services are not operating correctly. These services are then marked and checked 45 seconds later and if still in failure will be restarted. A maximum number of restarts over a 10 minute period can be configured to ensure that an infinite restart loop does not occur. Where a service exceeds the restart threshold, an external command can be executed to notify the System Administrators of the problem. (e.g. send a network message via the NET SEND command). The TMS Manager also provides an option to automatically cycle the services every N minutes (where N is configured in the registry). This may be useful in situations where serious problems are experienced with the services. The restarting of the services does not affect the users of TMS. The TMS Manager is configured through the registry (No Applet is provided for this, you need to use REGEDIT to make any changes). Note: The TMS Manager ignores the applications if they are run in debug mode. This should now be discouraged. 10.1.2Design Every 45 seconds (Poll Rate is configurable), the Service checks: 1. Asks the NT Service Control Manager whether the services are running. 2. Reads the TMS Manager registry values that are written by the services. 3. Performs health checks: • If the SCM has the service marked as NOT RUNNING, but the Registry value of the Service STATUS is set to 1(RUNNING), the service is deemed to have crashed and is restarted. • If the SCM has the service marked as RUNNING, but the Registry value of the Service STATUS is set to 0(NOT RUNNING), the service is deemed to have hung on Shutdown and is restarted. • If the SCM has the service marked as RUNNING and the Registry value of the Service STATUS is set to 1(RUNNING), the Count registry value is compared to the 184
  • 185. value read during the previous pass. If the value has not changed the service is deemed to have hung and is restarted. • If the up time (in minutes) of the service reaches the TMSManagerThreshold registry value then the Services are recycled. Two successive passes through the above loop must be made before the service is actually restarted. This ensures that timing peculiarities do not restart a service that is in transition. A Restart Count is maintained against each service. If this count exceeds the TMSManagerMaxAttempts registry value the service will not be restarted and the program specified in the TMSXXXFailureCmd Registry value will be executed. The Restart Count is reset every 10 minutes. The Restart of a service entails: 1. Perform a controlled Service Shutdown 2. Wait 15 Seconds 3. Terminate the Service EXE if still running (in case an error dialog has been displayed stopping the service from closing) 4. Wait 15 Seconds 5. Perform a controlled Service Start. 185
  • 186. 10.1.3Configuration Registry Key Description Default Value TMSManagerLogFn Optional path/filename to which restart Blank operations will be logged. To be used when diagnosing problems only TMSManagerPollSecs 45 TMSManagerMaxAttempts The number of restarts that can be 3 performed in a 10 minute period. Once Note: with a 45 second this value is exceeded the service will be poll, TMS Manager marked as dead and will not be restarted will take 1.5 mins again (requires manual restart at this before restarting the point) service. The restart takes 30 seconds. Therefore the max value is 5. TMSManagerThreshold If non-zero, the TMS Manager will cycle 720 (restart) the monitored services after the The services are number of minutes specified in this restarted every 12 fields hours. TMSServiceStatus 1 = running; 0 = not running - written by the service TMSServiceCnt Incrementing count to show that the service is operating. - written by the service TMSServerPid The service process Id – written by the service TMSServerFailureCmd An external program or command to be executed if the service restart exceeds the TMSManagerMaxAttempts rule TMSSMTPCnt Incrementing count to show that the service is operating. - written by the service TMSSMTPPid The service process Id – written by the service TMSSMTPFailureCmd An external program or command to be executed if the service restart exceeds the TMSManagerMaxAttempts rule. TMSFPCnt Incrementing count to show that the service is operating - written by the service TMSFPPid The service process Id – written by the service TMSFPCmd An external program or command to be executed if the service restart exceeds the TMSManagerMaxAttempts rule 186
  • 187. Index A E-Mail Notification Messages...............137 Access Mobile number from RightFax E-Mail Validation Errors.......................137 field......................................................86 Email Gateway......................................100 Account Name.........................................72 EMail Gateway........................................79 Account Password...................................72 Email Gateway Configuration.................32 Additional Setup Information..................21 Email Integration.......................................8 Admin Group...........................................86 Email Notifications and Validation.......100 Architecture Overview............................14 Email to SMS routing................................8 Audit Folder.............................................27 Embedded User Delimiters......................70 Authentication Server..............................85 Enable......................................................83 B Enable Delivery Notification...................71 Backup Folder Settings............................28 Enable user Emailing...............................71 C Encrypt data over IP................................73 Check First Word for Short Name...........70 Error Files Directory................................82 Client...................................10, 46, 49, 110 Exclude email body from SMS text........80 Client Authorisation Configuration.........84 F Client Components................................110 Feature Review..........................................8 Client Install Folder...........................44, 51 File Pickup Directory...............................82 Client Ready to Install.................46, 53, 54 File Processing.......................................102 Client Shortcut Folder.......................45, 52 File Processor..........................................82 Client User Information...........................50 File Processor Settings.............................29 Collect User Information.........................20 Finish Successfully..................................56 Configuration.........................................186 Folders Display..................................33, 34 Configure Modem....................................73 Force use of TMS Mail Libraries............80 Connectivity...............................................8 G Contacts.................................................118 General.....................................................83 Contacts Mode Context.........................112 General Tab.............................................73 Control Panel Applet...............................65 GSM Settings...........................................30 Create a Group of Local Contacts.........119 I Create a Local Contact..........................119 Importing Contacts........................124, 126 Create a New SMS Messages................116 Inbound (Drop) Configuration.................83 Create a New User Group......................132 Install Type..............................................22 Creating New Users...............................127 Installation Procedures............................17 Customer Integration...............................12 Installation Progress................................55 Customer Name.......................................72 Installing Files.........................................35 D Introduction...............................................8 Data Source..............................................70 IP Client Component...............................91 Database Folder.......................................27 IP Configuration................................31, 71 DCOM Server..........................................64 IP Failover...............................................72 Delete a User.........................................132 L Delivery Notifications.............................93 Licence Manager.....................................68 Design....................................................184 LogBrowser.............................................88 Diagnostics..............................................91 M Domain Options.......................................85 Main Application Window Modes........111 Drop Directory.........................................83 Main Settings...........................................70 E Manager.................................................184 E-Mail Access Errors.............................137 Manager Summary................................184 187
  • 188. Maximum Message Size....................79, 83 Restrict sending of SMS to registered users Maximum SMS Message Size.................94 .............................................................80 Message Allocation.................................93 Restricting Email Users.........................100 Message Encryption................................99 RightFax Options.....................................86 Message Mode Context.........................111 RightFax Security....................................98 Message Separator Character..................83 S Messages Tab..........................................78 Sales.......................................................183 Messaging..................................................9 Save Configuration......................81, 83, 86 Minimum System Requirements 17, 43, 49, Security........................................84, 86, 95 57 Select Contacts......................................117 Modify a User Group.............................132 Send Options..........................................117 Modify Call Charges.............................134 Send System Response Messages............71 Modify Contact......................................124 Sending an Email from an SMS Message Modify User Details..............................130 .............................................................94 N Sending and Receiving Messages..........115 Native TMS Security...............................95 Sending Email as an SMS Message......100 No Modem...............................................73 Sending SMTP Domain...........................70 O Server.................................................69, 93 Outbound Configuration..........................82 Server Connectivity...............................110 Outbound Processing.............................102 Server Installation....................................17 Outgoing Only.........................................94 Server Installation Folder..................23, 25 Outlook Client.................................57, 135 Service Management...............................66 Outlook Plugin File Installation Progress61 Service Name...........................................70 Outlook Plugin Finished Successfully.....62 Services....................................................63 Outlook Plugin Install Information..........60 Services Tab............................................76 Outlook Plugin Installation Folder..........59 Setting up Contacts................................118 Outlook Plugin User Information............58 Shortcut Folder........................................26 Outlook Welcome Screen........................57 Signatures..............................................118 Overview...............................................146 SMS to Email Routing...............................9 P SMTP Domain Name..............................79 Poll Period...................................70, 79, 83 SMTP Pickup Directory..........................79 Ports Tab..................................................75 Software Configuration...........................63 Postal Address.......................................183 Subject Line Only..................................100 Processed Files Directory........................82 Support...................................................183 Q System Backup Message.........................18 Quick Reference......................................92 System Mode Context...........................113 R T Rcvd Msg Sender Check.........................70 Technical Support..................................183 Reboot................................................42, 48 The System User....................................124 Receive email notification when SMS TMS Client Icons Explained.................114 delivered by SMC................................80 Trouble Shooting.....................................88 Receive email notification when SMS Sent U .............................................................80 User Authentication Mode.......................84 Receiving Modem Number.....................72 User Group..............................................86 Recipient Separator Character.................83 User Mode Context................................113 Relay Station Address.............................71 V Remove disclaimer from email body.......81 View Log.................................................73 Removing Email Disclaimer.................101 W Reporting.................................................12 Web Address..........................................183 Reports...................................................139 WebServicePage......................................71 188
  • 189. Welcome Screen....................18, 43, 46, 49 Windows Domain Security......................98 189