v7 User Guide.doc

1,421 views

Published on

Published in: Technology
0 Comments
0 Likes
Statistics
Notes
  • Be the first to comment

  • Be the first to like this

No Downloads
Views
Total views
1,421
On SlideShare
0
From Embeds
0
Number of Embeds
3
Actions
Shares
0
Downloads
12
Comments
0
Likes
0
Embeds 0
No embeds

No notes for slide

v7 User Guide.doc

  1. 1. 1
  2. 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. 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. 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. 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. 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. 7
  8. 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. 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. 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. 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. 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. 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. 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. 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. 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. 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. 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. 19
  20. 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. 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. 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. 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. 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. 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. 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. 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. 28. 2.1.12TMS Backup Folder Settings This dialog is shown in all installation types. 28
  29. 29. 2.1.13TMS File Processor Settings This dialog is shown in all installation types. 29
  30. 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. 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. 32. 2.1.16TMS Email Gateway Configuration The SMTP server name can be entered as part of the installation. 32
  33. 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. 34. TMS Folders Display The folders chosen to install the TMS Server are presented in this dialog. 34
  35. 35. 2.1.18TMS Installing Files During the installation of the files a progress bar is displayed. 35
  36. 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. 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. 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. 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. 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. 41. Then select yes to confirm the Upgrade of the database 41
  42. 42. 2.1.20TMS Reboot Once the installation has completed the Setup application will ask if you want to reboot (recommended). 42
  43. 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. 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. 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. 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. 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. 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. 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. 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. 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. 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. 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. 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. 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. 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. 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. 58. 3.2.3 TMS Outlook Plugin User Information 58
  59. 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. 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. 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. 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. 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. 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. 65. 4.3 Control Panel Applet TMS Server Configuration 65
  66. 66. 4.4 TMS Service Management 66
  67. 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. 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. 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. 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. 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. 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. 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. 74. You can alter the checking interval if necessary, but the default value is normally sufficient. 74
  75. 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. 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. 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. 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. 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. 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. 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. 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. 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. 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. 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. 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. 87
  88. 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. 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. 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. 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. 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. 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. 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. 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. 96
  97. 97. 97

×