Table of Contents 1 AQL SMS Gateway How to Guide...1

Transcription

1 Table of Contents 1 AQL SMS Gateway How to Guide AQL Overview Trial Account with 50 free SMS messages Prerequisites Configuring the AQL transport Configuring one or more AQL transports for Swivel 3.x Configuring the AQL details for Swivel 3.x Expected Results Troubleshooting IP address change AQL SMS logs Error messages AQL Voice AQL Overview Trial Account with 50 free credits Prerequisites Voice Considerations Configuring the AQL transport Configuring one or more AQL transports for Swivel 3.x Configuring the AQL details for Swivel 3.x Expected Results Troubleshooting Error messages Clickatell SMS Gateway How To Guide Clickatell Overview Prerequisites Configuring the Clickatell transport Clickatell Transport Class Configuring one or more Clickatall transports for PINsafe 3.x Configuring the Clickatall details for PINsafe 3.x Troubleshooting How to find the Clickatell API ID: Error messages CM SMS Gateway How to guide CM Overview Prerequisites Configuring the CM transport Swivel 3.8 or earlier software installation Configuring one or more CM transports for Swivel 3.x Configuring the CM details for Swivel 3.x Expected Results Troubleshooting Error messages Infobip SMS Gateway How to guide Infobip Overview Prerequisites...33 i

2 Table of Contents 33 Testing and Trials User Data Configuring the Infobip transport Configuring one or more Infobip transports for Swivel3.x Configuring the Infobip transport details for Swivel 3.x Expected Results Troubleshooting ITAGG SMS Gateway How to Guide itagg Overview Prerequisites Configuring the itagg transport Expected Results Troubleshooting NHS Mail SMS Gateway How to guide NHS Mail SMS Gateway IMPORTANT NEWS Overview Prerequisites Create and Configure the NHS Mail transport Expected Results Troubleshooting NowSMS How to guide NowSMS Overview NowSMS Prerequisites Configuring the NowSMS server Configuring the Now SMS server for SMPP Configuring Swivel for the the NowSMS transport Configuring Swivel for one or more NowSMS transports Configuring the NowSMS details for Swivel 3.x Expected Results Troubleshooting Error messages Packet Media Packet Media Overview Prerequisites Configuring the Packet Media transport Configuring one or more Packet Media transports for Swivel 3.x Configuring the transport details for Swivel 3.x Expected Results Troubleshooting Error messages Systor Vest SMS Gateway Overview Prerequisites Configuring the Systor Vest transport Swivel 3.6 to installation Configuring one or more Systor Vest transports for Swivel 3.x Configuring the Systor Vest details for Swivel 3.x Expected Results Troubleshooting Error messages...61 ii

3 1 AQL SMS Gateway How to Guide 1

4 2 AQL 2

5 3 Overview AQL allows SMS messages to be sent by connecting to their SMS gateway. AQL also support transmission by voice, see AQL Voice. AQL support the following connection methods: HTTP on port 80 (supported by Swivel) HTTPS on port 80 (supported by Swivel) 3

6 4 Trial Account with 50 free SMS messages Customers who wish to try Swivel with AQL may obtain a promo code for 50 free SMS messages see AQL Swivelpromo. To obtain the promo code see Aql-Swivel.pdf or contact sales@swivelsecure.com 4

7 5 Prerequisites AQL Account Swivel 3.x Mobile Phone on which to receive SMS text messages 5

8 6 Configuring the AQL transport 6.1 Configuring one or more AQL transports for Swivel 3.x On the Swivel Administration Console select Transport/General, locate the AQL transport. Enter the required group name and the number of security strings to be sent. Ensure that the transport attribute phone is selected. Identifier: Default: AQL, the name of the transport, must be unique Class: Default: com.swiveltechnologies.pinsafe.server.transport.aqltransport, the name of the java class used. To create multiple copies of a transport, copy this to a blank field at the bottom of the transport section. Strings per message: Default: 1, the number of security strings that are sent. Group: Default: ---NONE--- The group where security strings are sent to Alert repository group: Default: ---NONE--- The group where Alert messages are sent to Destination attribute: Default: phone, the attributes that is read from the data source to determine a users telephone number Click apply to save the settings. For further information see: Transport Configuration 6.2 Configuring the AQL details for Swivel 3.x Gateway URL: Default: recommended: the gateway used for sending messages to AQL Username: Default: blank, AQL account name Password: Default: blank, AQL account password Message Overwrite Default: No, Options Yes/No, this option allows the overwriting of previous text messages sent from PINsafe transport aql timeout: Default , timeout value for connection to gateway in milliseconds 6

9 7 Expected Results When a message is sent it is added to the message queue and then sent to the SMS gateway: Message added to message queue for user: graham, destination: Message sent to user: graham, destination:

10 8 Troubleshooting Try sending a security string or alert and check the Swivel log. Do you have an AQL account with username and password? Also see SMS messages are not being sent Check the connection, use TCP Dump, Wireshark, ethereal or similar to view the connection from Swivel to the SMS gateway. Look for outbound traffic of HTTP, on port 80, or HTTPS on port 80 to the SMS Gateway From the Swivel server can you Telnet to the gateway: telnet gw1.aql.com 443 Press enter and it should return an HTTP header, (Note the gateway to be used in the Swivel AQL configuration is Test ports using Telnet Service IP: gw.aql.com Service Port: 443 Trying Connected to gw1.aql.com ( ). Escape character is '^]'. From the Swivel server can you do an nslookup to gw1.aql.com nslookup gw.aql.com Server: google-public-dns-a.google.com Address: Non-authoritative answer: Name: gw1.aql.com Address: IP address change The IP address for gw1.aql.com changed in October If the IP address is used for Firewall entries etc then it may need to be re-entered. 8.2 AQL SMS logs login to using your account details and view SMS history from the Account Navigation, SMS, SMS history to see if SMS messages have reached AQL are attempting to be sent. 8.3 Error messages AQL_TRANSPORT_ERROR0 Authentication error The AQL gateway authentication has failed, verify the username and password for the account is correct. This can also be seen if the From field is incorrectly populated, try using a blank value. LOG_HTTP_TRANSPORT_ERROR, gw1.aql.com This error can be seen where the Swivel Appliance or server has no DNS configuration. Ensure that DNS is functioning. If DNS is updated a restart of Tomcat may be required. AQL_TRANSPORT_ERROR0 Insufficient credit or invalid number of msg/destination Either the account does not have enough credit to send an SMS and new credits must be purchased or the phone number is incorrect and the message cannot be sent. AQL_TRANSPORT_ERROR0 Authentication error LOG_NO_USER_FOR_DEST, Inbound SMS: Multiple users have same destination No session for Inbound OTC received from user graham This is a two way SMS authentication error message. An inbound SMS message has not been received. LOG_HTTP_TRANSPORT_ERROR, No route to host There is no network connection to the Gateway. Check that a network connection exists and that there are no firewall devices blocking the connection. 8

11 9 AQL Voice 9

12 10 AQL 10

13 11 Overview AQL allows SMS messages to be sent by by Voice or SMS by connecting to their gateway. This document details how to configure the AQL Voice. AQL support the following connection methods: HTTP on port 80 (supported by Swivel) HTTPS on port 80 (supported by Swivel) 11

14 12 Trial Account with 50 free credits Customers who wish to try Swivel with AQL may obtain a promo code for 50 free SMS messages see AQL Swivelpromo. To obtain the promo code see Aql-Swivel.pdf or contact sales@swivelsecure.com 12

15 13 Prerequisites AQL Account Swivel 3.x Phone on which to receive Voice calls Voice Considerations Use of PINless to send a One Time Code may be more practical for voice than the Security String. The Voice transport may be better suited to On Demand Authentication rather than the standards pre-sent delivery. AQL Voice uses Dual Channel transport rather than the Voice channel. 13

16 14 Configuring the AQL transport 14.1 Configuring one or more AQL transports for Swivel 3.x On the Swivel Administration Console select Transport/General, locate the AQL transport. Enter the required group name and the number of security strings to be sent. Ensure that the transport attribute phone is selected. Identifier: Default: AQL, the name of the transport, must be unique, example AQL Voice Class: Default: com.swiveltechnologies.pinsafe.server.transport.aqlvoicetransport, the name of the java class used. To create multiple copies of a transport, copy this to a blank field at the bottom of the transport section. Strings per message: Default: 1, the number of security strings that are sent. Group: Default: ---NONE--- The group where security strings are sent to Alert repository group: Default: ---NONE--- The group where Alert messages are sent to Destination attribute: Default: phone, the attributes that is read from the data source to determine a users telephone number Click apply to save the settings. For further information see: Transport Configuration 14.2 Configuring the AQL details for Swivel 3.x Under Transport, then the AQL Voice transport, Remove all the following from each of the transports: %CR, %LF Gateway URL: Default: the gateway used for voice connections Username: Default: blank, AQL account name Password: Default: blank, AQL account password String Header: Default: Yes, set to No, used for the position indicator (1-10) Vertical Strings: Default: No, set to No, used for vertical display of strings, not applicable in voice 14

17 15 Expected Results When a message is sent it is added to the message queue and then sent to the Voice gateway: Message added to message queue for user: graham, destination: Message sent to user: graham, destination:

18 16 Troubleshooting Try sending a security string or alert and check the Swivel log. Also see SMS messages are not being sent Check the connection, use TCP Dump, Wireshark, ethereal or similar to view the connection from Swivelto the SMS gateway. Look for outbound traffic of HTTP, on port 80, or HTTPS on port 80 to the SMS Gateway Error messages AQL_TRANSPORT_ERROR0 Authentication error The AQL gateway authentication has failed, verify the username and password for the account is correct. This can also be seen if the From field is incorrectly populated, try using a blank value. LOG_HTTP_TRANSPORT_ERROR, gw1.aql.com This error can be seen where the Swivel Appliance or server has no DNS configuration. Ensure that DNS is functioning. If DNS is updated a restart of Tomcat may be required. AQL_TRANSPORT_ERROR0 Insufficient credit or invalid number of msg/destination Either the account does not have enough credit to send a message and new credits must be purchased or the phone number is incorrect and the message cannot be sent. LOG_HTTP_TRANSPORT_ERROR, No route to host There is no network connection to the Gateway. Check that a network connection exists and that there are no firewall devices blocking the connection. 16

19 17 Clickatell SMS Gateway How To Guide 17

20 18 Clickatell 18

21 19 Overview Clickatell allows SMS messages to be sent by connecting to their SMS gateway. Clickatell support the following connection methods including: HTTP on port 80 (supported by PINsafe) HTTPS on port 443 (supported by PINsafe) SMTP on port 25 (supported by PINsafe through generic SMTP to SMS) SMPP (SMPP is supported by PINsafe but not used for Clickatell) 19

22 20 Prerequisites Clickatell Account PINsafe 3.x Mobile Phone on which to receive SMS text messages 20

23 21 Configuring the Clickatell transport 21.1 Clickatell Transport Class Swivel has two Cliackatell classes for SMS transport: Default menu item, defined as: com.swiveltechnologies.pinsafe.server.transport.clickatelltransport HTTP version with Sender ID. com.swiveltechnologies.pinsafe.server.transport.clickatellhttptransport is a manually configured transport. The HTTP version Java Class is shipped with Swivel from Swivel version 3.9 onwards. For Swivel versions 3.6 onwards it can be downloaded here ClickatellHttpTransport 21.2 Configuring one or more Clickatall transports for PINsafe 3.x On the PINsafe Administration Console select Transport/General, locate the clickatell transport. Enter the required group name and the number of security strings to be sent. Identifier: Default: Cliackatell, the name of the transport, must be unique Class: Default: com.swiveltechnologies.pinsafe.server.transport.clickatelltransport, the name of the java class used. To create multiple copies of a transport, copy this to a blank field at the bottom of the transport section. Strings per message: Default: 1, the number of security strings that are sent. Group: Default: ---NONE--- Where security strings are sent to Alert repository group: Default: ---NONE--- Where Alert messages are sent to Destination attribute: Default: phone, the attributes that is read from the data source to determine a users telephone number Click apply to save the settings. For further information see: Transport Configuration 21.3 Configuring the Clickatall details for PINsafe 3.x Username: Default: blank, Clickatell account name Password: Default: blank, Clickatell account password API ID: Default: blank, Clickatell API ID, this is provided by clickatell Encoding: Default: GSM, Options GSM or UCS2, select if GSM or UCS2 is to be used Protocol: Default HTTP, Options HTTP or HTTPS, select if SSL is to be used 21

24 22 Troubleshooting Try sending a security string or alert and check the PINsafe log. Also see SMS messages are not being sent Check the connection, use TCP Dump, Wireshark, ethereal or similar to view the connection from PINsafe to the SMS gateway. Look for outbound traffic of HTTP, on port 80, or HTTPS on port 8443 to the SMS Gateway api.clickatell.com. Can you Telnet to the gateway: telnet api.clickatell.com 80 Press enter and it shoud return an HTTP header. In 2012 Clickatell changed their IP address to from , swivel references the server by hostname api.clickatell.com and if DNS is correctly working then no changes should be required. However check for the presence of a hosts entry specifying the old IP How to find the Clickatell API ID: The API_ID is not the same as the username. To find the API ID: 1) Log into the clickatell account at 2) Click on the 'Product Control' link. 3) Click on the name of the API you want to use. The API ID will be displayed on the main page. If it is not displayed you will be asked to complete a form after completing the form you will see your API_ID Error messages Clickatell message sending failed, error: org.marre.sms.smsexception: org.marre.sms.transport.clickatell.clickatellexception: Clickatell error. Error 001, Authentication failed Wrong username, password or API ID for Clickatell SMS account java.net.connectexception: connection timed out: connect or LOG_HTTP_TRANSPORT_ERROR, Connection Timed Out Connection to Clickatell SMS Gateway failed with the connection timing out. Verify that the PINsafe server connection to the SMS gateway is not being blocked by a firewall or proxy server. Clickatell message sending failed, error: org.marre.sms.smsexception: Alphanumeric address can be at most 11 chars. The message may be too long if it includes spaces, dashes and other characters. This can be resolved in the following ways: Ensure mobile numbers are entered without dashes, spaces etc Use the Transport filtering options in PINsafe 3.8 Clickatell message sending failed, error: org.marre.sms.smsexception: org.marre.sms.transport.clickatell.clickatellexception: Clickatell error. Error 108, Invalid or missing api_id The API ID used in the Clickatell configuration is incorrect. Clickatell message sending failed, error: org.marre.sms.smsexception: Clickatell error. Error 114, Cannot route message The phone number has been submitted in the wrong format. Try with country code. 22

25 23 CM SMS Gateway How to guide 23

26 24 CM 24

27 25 Overview CM allows SMS messages to be sent by connecting to their SMS gateway. CM support the following connection methods including: HTTP on port 80 (supported by Swivel) HTTPS on port 80 (supported by Swivel) 25

28 26 Prerequisites CM Account Swivel 3.9 or higher or the CM PINsafe transport software Mobile Phone on which to receive SMS text messages 26

29 27 Configuring the CM transport The CM software is included as part of Swivel 3.9, for earlier versions of software it needs to be installed Swivel 3.8 or earlier software installation Swivel version 3.6 onwards. Download the software, unzip and extract the following files and copy them to the correct locations given below, then restart Tomcat. CorporateMobileMessagingTransport.class to <path to pinsafe>/web-inf/classes/com/swiveltechnologies/pinsafe/server/transport CorporateMobile.en.xml to <path to pinsafe>/web-inf/languages Ensure file permissions ownership are the same as other files in the folder Configuring one or more CM transports for Swivel 3.x On the Swivel Administration Console select Transport/General, select New Entry. Enter the required group name and the number of security strings to be sent. Ensure that the transport attribute phone is selected. Identifier: the name of the transport, must be unique Class: Default: com.swiveltechnologies.pinsafe.server.transport.corporatemobilemessagingtransport, the name of the java class used. To create multiple copies of a transport, copy this to a blank field at the bottom of the transport section. Strings per message: Default: 1, the number of security strings that are sent. Group: Default: ---NONE--- Where security strings are sent to Alert repository group: Default: ---NONE--- Where Alert messages are sent to Destination attribute: Default: phone, the attributes that is read from the data source to determine a users telephone number Click apply to save the settings. For further information see: Transport Configuration 27.3 Configuring the CM details for Swivel 3.x Gateway URL: Default: the gateway used for sending messages to CM Username: Default: blank, CM account name Password: Default: blank, CM account password Sender: Default: blank, Senders details that are viewed by the recipient. Do not use blank spaces Customer ID: Default 0, Customer ID 27

30 27.4 Expected Results When a message is sent it is added to the message queue and then sent to the SMS gateway: Message added to message queue for user: graham, destination: LOG_CORPORATE_MOBILE_MESSAGE_SENT Message sent to user: graham, destination:

31 28 Troubleshooting Try sending a security string or alert and check the Swivel log. Also see SMS messages are not being sent If messages are being sent from Swivel but not being received by users, check the CM logs through the CM account Error messages LOG_CORPORATE_MOBILE_MESSAGE_ERROR, Error: ERROR No account found for the given credentials (customer/login/password combination) Incorrect username, password or Customer ID. LOG_HTTP_TRANSPORT_ERROR, No route to host There is no network connection to the Gateway. Check that a network connection exists and that there are no firewall devices blocking the connection. 29

32 29 Infobip SMS Gateway How to guide 30

33 30 Infobip 31

34 31 Overview Infobip allows SMS messages to be sent by connecting to their SMS gateway. Infobip support a variety of connection methods, and Swivel can integrate with their SMPP protocol for sending SMS messages. 32

35 32 Prerequisites Infobip Account Swivel 3.x Mobile Phone on which to receive SMS text messages 33

36 33 Testing and Trials Contact Infobip for setting up SMS accounts for testing and trial. 34

37 34 User Data The mobile phone number is expected to use country code: <countrycode><telephonenumber> Example:

38 35 Configuring the Infobip transport 35.1 Configuring one or more Infobip transports for Swivel3.x On the Swivel Administration Console select Transport/General, and select New Entry Identifier: Infobip, the name of the transport, must be unique Class: com.swiveltechnologies.pinsafe.server.transport.smpptransport Strings per message: Default: 1, the number of security strings that are sent. Group: Default: ---NONE--- Where security strings are sent to Alert repository group: Default: ---NONE--- Where Alert messages are sent to Destination attribute: phone, the attribute that is read from the data source to determine a users telephone number Click apply to save the settings. For further information see: Transport Configuration 35.2 Configuring the Infobip transport details for Swivel 3.x Server: smpp1.infobip.com, the gateway used for sending messages using Infobip Port: Default: 2775, Infobip setting required: 8888, the port used for communication to the Infobip gateway System Type: Default: pcsms Username: Default: blank, Infobip account name Password: Default: blank, Infobip account password, limited to 8 characters Source Address: Default: blank Source TON: Default: 5 Source NPI: Default: 0 Destination TON: Default: 1 Destination NPI: Default: 0 Keep Alive: Default: No, Options Yes/No Keep Alive Time: Default: Expected Results When a message is sent it is added to the message queue and then sent to the SMS gateway: Message added to message queue for user: graham, destination: Message sent to user: graham, destination: Troubleshooting Try sending a security string or alert and check the Swivel log. Also see SMS messages are not being sent Check the connection, use TCP Dump, Wireshark, ethereal or similar to view the connection from Swivel to the SMS gateway. Look for outbound traffic on port 8888 to the SMS Gateway. Can you Telnet to the gateway Error messages LOG_HTTP_TRANSPORT_ERROR, No route to host There is no network connection to the Gateway. Check that a network connection exists and that there are no firewall devices blocking the connection. bind error Connection timed out Attemping to bind, conn = null Wrong port specified 36

39 Error binding: 14 Still not bound 0 The username or password is incorrect Exception while processing message: ie.omk.smpp.message.invalidparametervalueexception: Invalid password Password is incorrect for the given username. The password is limited to 8 characters in length. 37

40 36 ITAGG SMS Gateway How to Guide 36.1 itagg 36.2 Overview itagg allows SMS messages to be sent by connecting to their SMS gateway. itagg support the following connection methods including: HTTP on port 80 (supported by Swivel) HTTPS on port 80 (supported by Swivel) 36.3 Prerequisites itagg Account Swivel 3.x Mobile Phone on which to receive SMS text messages 36.4 Configuring the itagg transport Configuring one or more itagg transports for Swivel 3.x On the Swivel Administration Console select Transport/General, locate the itagg transport. Enter the required group name and the number of security strings to be sent. Ensure that the transport attribute phone is selected. Identifier: Default: itagg, the name of the transport, must be unique Class: Default: com.swiveltechnologies.pinsafe.server.transport.itaggtransport Transport, the name of the java class used. To create multiple copies of a transport, copy this to a blank field at the bottom of the transport section. Strings per message: Default: 1, the number of security strings that are sent. Group: Default: ---NONE--- Where security strings are sent to Alert repository group: Default: ---NONE--- Where Alert messages are sent to Destination attribute: Default: phone, the attributes that is read from the data source to determine a users telephone number Click apply to save the settings. For further information see: Transport Configuration Configuring the itagg details for Swivel 3.x Gateway URL: Default: the gateway used for sending messages to itagg, the following setting has been tested: secure.itagg.com/smsg/sms.mes Username: Default: blank, itagg account name Password: Default: blank, itagg account password Default route: Default 7(National UK), itagg routing to be used transport itagg timeout: Default , timeout value for connection to gateway in milliseconds Protocol: Default HTTP, SSL or non SSL connection 36.5 Expected Results When a message is sent it is added to the message queue and then sent to the SMS gateway: Message added to message queue for user: graham, destination: Message sent to user: graham, destination: Troubleshooting Try sending a security string or alert and check the Swivel log. Also see SMS messages are not being sent Check the connection, use TCP Dump, Wireshark, ethereal or similar to view the connection from Swivelto the SMS gateway. Look for outbound traffic to the SMS Gateway Can you Telnet to the gateway. 38

41 Error messages itagg message sending failed, error: error code error text submission reference 102 submission failed due to insufficient credit 0 The SMS gateway has run out of credit to send SMS messages. LOG_HTTP_TRANSPORT_ERROR, java.security.cert.certificateexception: No subject alternative DNS name matching found. Incorrect gateway path, try secure.itagg.com/smsg/sms.mes 39

42 37 NHS Mail SMS Gateway How to guide 37.1 NHS Mail SMS Gateway 37.2 IMPORTANT NEWS NHS have advised all Trusts across the UK that the SMS service available with NHS mail will be discontinued as from 31st March Overview NHS Mail allows SMS messages to be sent by connecting to their SMS gateway. NHS Mail support the following connection methods including: SMTP on port 25 (supported by Swivel) 37.4 Prerequisites NHS Mail Account Swivel 3.x Mobile Phone on which to receive SMS text messages 37.5 Create and Configure the NHS Mail transport Create the NHS Mail Transport On the Swivel Administration console select Transport/General, then click on New Entry Configuring one or more NHS Mail transports for Swivel 3.x On the Swivel Administration Console Transport/General screen, for the entry created above enter the following parameters: Identifier: NHS Mail Class: Default: com.swiveltechnologies.pinsafe.server.transport.nhsmailtransport Strings per message: Default: 1, the number of security strings that are sent. Strings Repository Group: choose a group where security strings are sent to Alert repository group: choose a group where Alert messages are sent to Destination attribute: phone Click apply to save the settings. For further information see: Transport Configuration Configuring the NHS Mail details for Swivel 3. x Mail server/host: send.nhs.net Port:

43 Connection Timeout (s): 20 Account username: username for NHS Mail account Domain Account password: Password for the NHS Mail account Authentication Required: Yes Enable debug: No, unless indicated by Swivelsecure support 37.6 Expected Results The Swivel log should indicate when a message is sent it is added to the message queue and then sent to the SMS gateway: 37.7 Troubleshooting Try sending a security string or alert and check the Swivel log. Also see SMS messages are not being sent Error messages Sending via NHS Sendmail failed to javax.mail.messagingexception: Can't send command to SMTP host; nested exception is: javax.net.ssl.sslhandshakeexception: sun.security.validator.validatorexception: PKIX path building failed: sun.security.provider.certpath.suncertpathbuilderexception: unable to find valid certification path to requested target This error has been seen due to an upgrade of the SSL certificate on the NHS Mail gateway. The first time the certificate was altered was on 14th October at 3.30pm. You will need to obtain the latest NHS Mail certificate and upload it to the Java trusted certificates store on the Swivel appliance. The steps to do this are as follows: If you do not have a copy of the NHS mail certificate, you can find it here. Use WinSCP or Webmin to upload the NHSMail.cer file to the /backups/upload directory on the appliance. See the WinSCP How To Guide for help with using WinSCP. Connect to the Swivel appliance using PuTTY and get to the command line via the Advanced Menu. For help with using PuTTY, see the PuTTY How To Guide. Enter the following commands: cd /usr/java/default/lib/security cp cacerts cacerts.bak keytool -importcert -keystore cacerts -alias NHSMail -file /backups/upload/nhsmail.cer These commands, switch to the directory containing the java root store, make a backup copy of the certificates store, and then import the NHSMail certificate as a trusted root certificate. On the final command, you will be asked for the password for the keystore which is "changeit". It will display the certificate, and then ask you to confirm you want to trust it (type "yes"). If you are installing an update to an existing certificate, and you get an error on the last command that the alias NHSMail already exists, use the following command to delete the old NHSMail: keytool -delete -keystore cacerts -alias NHSMail Then re-try the last command. Finally, restart Tomcat. This will register the modified certificate store. If anything goes wrong at this point, you can revert to the backup copy of the certificate store and restart Tomcat. If there is more than one appliance, you will need to perform this task on the other appliances where the NHS Mail transport will be used, this includes other nodes in a High Availability pair. 41

44 38 NowSMS How to guide 42

45 39 NowSMS 43

46 40 Overview NowSMS allows SMS messages to be sent by connecting to their SMS gateway software. See also the MOXA NPort Ethernet to Serial 44

47 41 NowSMS NowSMS offer a free trial of their software, see their website for details. 45

48 42 Prerequisites NowSMS software and GSM modem Swivel 3.x Mobile Phone on which to receive SMS text messages 46

49 43 Configuring the NowSMS server Follow the NowSMS documentation and configure for web authentication and test that it is working for sending sms messages Configuring the Now SMS server for SMPP On the NowSMS Gateway configuration select the Web tab, and then tick enable SMPP Server, then configure the following Port number for SMPP Server: 8802 Under the SMS users tab, selert Add User, enter a username and password then tick Enable SMPP login for this user. 47

50 44 Configuring Swivel for the the NowSMS transport Swivel uses the SMPP protocol to talk to the NowSMS gateway Configuring Swivel for one or more NowSMS transports On the Swivel Administration Console select Transport/General, select Transport/General New Entry. Enter the required group name and the number of security strings to be sent. Ensure that the transport attribute phone is selected. Identifier: the name of the transport, must be unique. Class: Use the following: com.swiveltechnologies.pinsafe.server.transport.smpptransport, the name of the java class used. Strings per message: Default: 1, the number of security strings that are sent. Group: Default: ---NONE--- The group where security strings are sent to Alert repository group: Default: ---NONE--- The group where Alert messages are sent to Destination attribute: Default: phone, the attributes that is read from the data source to determine a users telephone number Click apply to save the settings. For further information see: Transport Configuration 44.2 Configuring the NowSMS details for Swivel 3.x Server: Default: The NowSMS server address the gateway used for sending messages using NowSMS Port: 8802 System Type: pcsms Username: Default: blank, NowSMS account name, this is a required field Password: Default: blank, NowSMS account password, this is a required field Source Address: Source TON: 5 Source NPI: 0 Destination TON: 1 Destination NPI: 0 Keep Alive: No Keep Alive Time:

51 45 Expected Results When a message is sent it is added to the message queue and then sent to the SMS gateway: Message added to message queue for user: graham, destination: Message sent to user: graham, destination: A more detailed log is given below: Message sent to user: graham, destination: Send response0, 0 Bounded Notifying observers of packet received Setting state 2 Receiver thread started Boundie.omk.smpp.Connection@65a4e9,1 Setting state 1 Opening TCP socket to NowSMSserver/ :Opening network link. Binding to the SMSC as type 3 Creating receiver thread Using event dispatcher ie.omk.smpp.event.simpleeventdispatcher connecting Attemping to bind, conn = unbound Message added to message queue for user: graham, destination:

52 46 Troubleshooting Try sending a security string or alert and check the Swivel log. Also see SMS messages are not being sent Check the connection, use TCP Dump, Wireshark, ethereal or similar to view the connection from Swivel to the SMS gateway. Can you Telnet to the gateway Error messages 50

53 47 Packet Media 51

54 48 Packet Media 52

55 49 Overview Packet Media allows SMS messages to be sent by connecting to their SMS gateway. Packet Media support the following connection methods: HTTPS on port 443 (supported by Swivel) 53

56 50 Prerequisites Packet Media Account Swivel 3.x Mobile Phone on which to receive SMS text messages 54

57 51 Configuring the Packet Media transport 51.1 Configuring one or more Packet Media transports for Swivel 3.x On the Swivel Administration Console select Transport/General, select New Entry. Enter the required group name and the number of security strings to be sent. Ensure that the transport attribute phone is selected. Identifier: the name of the transport, must be unique Class: Default: com.swiveltechnologies.pinsafe.server.transport.packetmediatransport, the name of the java class used. To create multiple copies of a transport, copy this to a blank field at the bottom of the transport section. Strings per message: Default: 1, the number of security strings that are sent. Group: Default: ---NONE--- Where security strings are sent to Alert repository group: Default: ---NONE--- Where Alert messages are sent to Destination attribute: Default: phone, the attributes that is read from the data source to determine a users telephone number Click apply to save the settings. For further information see: Transport Configuration 51.2 Configuring the transport details for Swivel 3.x Gateway URL: Default: the gateway used for sending messages Username: Default: blank, account name Password: Default: blank, account password Vertical Strings: Default No, options: Yes/No, send the security strings vertically instead of horizontally 51.3 Expected Results From the Swivel log INFO Message sent to user: test, destination: INFO admin:message added to message queue for user: test, destination:

58 52 Troubleshooting Try sending a security string or alert and check the Swivel log. Also see SMS messages are not being sent If messages are being sent from Swivel but not being received by users, check the Packet Media logs Error messages WARN PACKETMEDIA_ERROR"Number in stop list","responsecode""f8" The user has replied to a Packet Media SMS message with the word STOP. This prevents further sending of SMS text messages to the user. To remove this contact Packet Media 56

59 53 Systor Vest SMS Gateway 57

60 54 Overview Systor Vest allows SMS messages to be sent by connecting to their SMS gateway. Systor Vest support the following connection methods including: HTTP on port 80 (supported by Swivel) HTTPS on port 443 (supported by Swivel) 58

61 55 Prerequisites Systor Vest Account Swivel version higher than or the Systor Vest transport software Mobile Phone on which to receive SMS text messages 59

62 56 Configuring the Systor Vest transport The Systor Vest software is to be included as part of PINsafe 3.9.3, for earlier versions of software it needs to be installed Swivel 3.6 to installation Download the software, unzip and extract the following files and copy them to the correct locations given below, then restart Tomcat. Systorsms.class to <path to pinsafe>/web-inf/classes/com/swiveltechnologies/pinsafe/server/transport Ensure file permissions ownership are the same as other files in the folder Configuring one or more Systor Vest transports for Swivel 3.x On the Swivel Administration Console select Transport/General, locate the Systor Vest transport. Enter the required group name and the number of security strings to be sent. Ensure that the transport attribute phone is selected. Identifier: Default: Systor Vest, the name of the transport, must be unique Class: Default: com.swiveltechnologies.pinsafe.server.transport.systorvest, the name of the java class used. To create multiple copies of a transport, copy this to a blank field at the bottom of the transport section. Strings per message: Default: 1, the number of security strings that are sent. Group: Default: ---NONE--- Where security strings are sent to Alert repository group: Default: ---NONE--- Where Alert messages are sent to Destination attribute: Default: phone, the attributes that is read from the data source to determine a users telephone number Click apply to save the settings. For further information see: Transport Configuration 56.3 Configuring the Systor Vest details for Swivel 3.x Gateway URL: Default: the gateway used for sending messages by Systor Vest Username: Default: blank, Systor Vest account name Password: Default: blank, Systor Vest account password Sender: Default: blank, Senders details that are viewed by the recipient. Do not use blank spaces Flah: Flash SMS 56.4 Expected Results When a message is sent it is added to the message queue and then sent to the SMS gateway: Message added to message queue for user: graham, destination: LOG_CORPORATE_MOBILE_MESSAGE_SENT Message sent to user: graham, destination:

63 57 Troubleshooting Try sending a security string or alert and check the Swivel log. Also see SMS messages are not being sent If messages are being sent from Swivel but not being received by users Error messages 61