Sms4Domino Help About this database Sms4Domino is an application that delivers SMS (short messaging service) capabilities to Domino applications. End users send and receive SMS messages the same way as they send and receive e-mail messages. The application is fully integrated in the Domino environment . Domino administrators will feel at ease when configuring and monitoring the application. The application performs all processing in Lotus Domino® databases .
Sms4Domino Help Revision history The version of the software is printed at the console when the application is started . Version Description 3.3 (January 2013) - New features Textual error code for Cinterion modem Possibility to reply from the user's mailbox to received SMS More granular configuration of inbound routing 3.0 (September 2012) - New features Multi-server implementations Clustered implementations Least cost routing Creation of accounting records for inbound and outbound traffic 2.
Sms4Domino Help System architecture For small configurations there will be one instance of the Sms 4Domino program. In order to handle heavier workloads, to perform least cost routing, to increase service availability it may be required to roll-out more than one Sms4Domino instance on multiple Domino servers. First the single instance configuration is described . This will then be used as a building block for creating a multi-instance set-up.
Sms4Domino Help Single Instance system architecture Sms4Domino integrates in any Domino infrastructure. Following drawing illustrates the architecture when Sms4Domino is running as a server addin. Typically the configuration database and the Sms4Domino program are located on the same server. One or more modems are connected via either COM ports or via the LAN to the Domino server. Sms4Domino may also connect to a SMS service provider (e.g. Clickatell) over HTTP.
Sms4Domino Help -5-
Sms4Domino Help Multi Instance system architecture Why a multi instance architecture The main reasons for working in a multi-instance configuration are Improved reliability: when one Domino server becomes unavailable users may continue sending SMS messages via one the other servers. Domino routing and replication may be configured in such a way that this is transparant for them.
Sms4Domino Help Limitations of this release Some features that are described in the help file or on the configuration settings have not yet been implemented. Sms4Domino may be rolled-out as a multi-database application (configuration database, accounting database, ...). In the current release all Sms4Domino features must be part of a single configuration database. This database may be replicated to multiple servers. Not all Interface families have been implemented.
Sms4Domino Help 30 minute installation guide The installation should be straightforward for a Lotus Domino® system administrator . We will give overviews for deploying a single instance or multi instance configuration . Before you begin Acquire one or more industrial grade GSM modems (e.g. Cinterion® MC55iT) and corresponding SIM cards. (During the development of Sms4Domino we tested many different modems.
Sms4Domino Help RunJava) or as a standalone program on a PC where Lotus Notes® clients has been installed. Installation steps This document contains only a checklist of all installation steps . More information is available in subsequent documents. 1. Obtain a copy of the Sms4Domino template. Sign the template with a proper user id. Adapt the ACL to your local standards. 2. Create a configuration database on a Domino server. (The database must always reside on a server - not on a workstation).
Sms4Domino Help Choice and installation of the modem or Sms service provider Sms4Domino is running on top of SmsLib. This software is responsible for the communication with the modem. SmsLib supports different kind and models of modems like a USB connected GSM, an industrial modem connected via a serial COM port, a modem directly connected to the LAN or a SMS service provider like Clickatel . In the current release Sms4Domino supports a local or LAN connected modem or a connection via a service provider.
Sms4Domino Help - 11 -
Sms4Domino Help The modem may be tested via the query tool under the Diagnostics tab .
Sms4Domino Help COM test program The next example is based on the Advanced Serial Port monitor (evaluation version available on http://www.aggsoft.com).
Sms4Domino Help The program must be started in administrator mode. Open the port at the speed configured in the modem. Send the AT command to the modem. The modem should respond with OK.
Sms4Domino Help Putty (http:// http ://www :// www. www .putty. putty .org) org ) Putty is a free open source telnet client. It is normally used to communicate with devices connected to the LAN. However, in serial mode, it is perfectly suited to test the modem connected to the com port. Download putty to your local Windows machine. Executy the putty.
Sms4Domino Help Configure your session (Clickon Session in the left pane) Connection type = serial Serial line = the COM port you are using Speed = the default speed for your modem - 16 -
Sms4Domino Help Specify additional settings for the serial connection (click on Connection -> Serial in the left pane) Data bits: 8 Stop bits: 1 Parity: None Flow control: RTS/CTS You are now ready to test the connection with your modem. Click on open.
Sms4Domino Help - 18 -
Sms4Domino Help Initial configuration of the Cinterion MC 55iT 55iT modem Sms4Domino assumes the modem has been properly initialized. This is true for a Cinterion modem that uses the factory default settings. However, when a modem is moved from some other project to Sms4Domino it may be necessary to change some modem settings. Changing the settings is done by sending AT commands to the modem. We prefer connecting the modem directly to a serial port.
Sms4Domino Help Within the Session category select the COM port (COM4 in above example) and the speed. 57600 bps will be recognized by the modem if AutoBauding is still enabled . Acceptable speeds for the Cinterion modem are 300, 600, 1200, 2400, 4800, 9600, 14400, 19200, 28800, 38400, 57600, 115200 and 230400 bits per second. AutoBauding is only possible for speeds up to 115200 bps.
Sms4Domino Help Within the Connection -> Serial category specify the settings for data bits, stop bits, parity and flow control. Factory default settings are 8 data bits, 1 stop bit, no parity and no flow control. Click Open. A pop-up window is displayed.
Sms4Domino Help Enter the letters AT followed by pressing Return. The could be an echo of AT. The modem should respond with OK If there is no respons from the modem you should verify your settings. Reset the modem to the factory defaults The AT&F command resets all modem parameters to the manufacturer defined profile. The modem response should be OK. The AT&V command lists the current parameters. Consult the Cinterion AT command guide for more info.
Sms4Domino Help Set the required modem parameters The modem communication will be more reliable if autobauding is not used . The bit rate is specified by the AT+IPR= command. Values of are 0 for autobauding, 300, 600, ...., 57600, 115200, 230400. The setting will not be changed by the above AT&F command.
Sms4Domino Help Flow control between the computer and the modem must be set to hardware flow control (using RTS/CTS). Hardware flow control must be set on both sides: with AT\Q3 in the ME and an equivalent RTS/CTS handshake option in the host application. The default setting of the modem is AT\Q0 (no flow control) which must be altered to AT\Q3 (RTS/CTS hardware handshake on). The setting is stored volatile and must be restored each time after rebooting the ME. AT\Q has no read command.
Sms4Domino Help Later, when configuring the Sms4Domino environment and gateways, you should define the same parameter settings. Save the settings to non volatile RAM The AT&W command is used to store the settings to non volatile RAM. The modem responds with OK. Sms4Domino will issue the ATZ command as one of the first commands to load the settings into memory.
Sms4Domino Help Verify the PIN code of the SIM card Power down the modem. Insert a valid SIM card. You should have received a corresponding PIN code. The AT+CPIN write command can be used to enter one of the passwords listed below. The read command can be used to check whether or not the ME is waiting for a password, or which type of password is required.
Sms4Domino Help Appendix: Cinterion AT command guide mc52i_atcommands_v01201a.
Sms4Domino Help Configuration of the ATOP SE 5000 Serial server In case no COM ports are available or when the GSM modem should be located outside the computer room it possible to connect the modem to a serial server. This device acts as a gateway between the Ethernet LAN and the COM modems. The configuration of the serial server is documented in the user guide. The current help document guides you through the setup.
Sms4Domino Help Connect the serial server to your computer. You need two straight cables and a switch or you could use a crossed cable and make a direct connecten between you PC and the serial server. Test the connection by ping-ing the serial server. The serial server may be configured via the command line or using a browser . Internet Explorer should be used. Enter http://10.0.50.100 as Url.
Sms4Domino Help - 30 -
Sms4Domino Help Assign a fixed IP address to the Serial Server Ask your network administrator for a free IP address that is compatible with your network addressing scheme. The address may be assigned via DHCP or may be entered as a fixed address in the device. Sms4Domino requires the knowledge of this address.
Sms4Domino Help Click on Save Configuration followed by Restart. You are now ready to connect the serial server to the LAN. Further configuration steps must be using the above assigned IP address. Configure the serial server Following instructions must be repeated for each of the COM ports. In the example we will configure COM1.
Sms4Domino Help Sms4Domino supports TCP/IP connected modems. There is no need for special driver software that must be installed in Windows. The serial server must be configured with following settings TCP Server Enable VirtualCOM for Serial/IP: No Pair Connection: No Reverse Telnet Mode: No Local Listening Port: 4660 or any other value. The same value must be specified in the Sms4Domino gateway definition document IP filter: this is a security feature.
Sms4Domino Help COM Type Selection: RS232 Click the Save button to save the settings. Test the connection We assume the modem has already been configured. Connect the modem to the COM port of the serial server. Open a Dos box and enter the command (assuming the serial server is configured for IP address 10.0.50.100 and to listen on port 4660) telnet 10.0.50.100 4660 The Dos window is cleared. Type AT. The modem should respond with OK After the configured idle time the connection is closed automatically .
Sms4Domino Help Appendix: Atop user guide SE5002 Serial- Ethernet User's Manual (V1.3).
Sms4Domino Help Configuration of Nokia GSM modem An evaluation version of Sms4Domino may be downloaded. During that period you could consider using a GSM (mobilephone) for sending and receiving Sms messages. We strongly recommend to obtain an industrial grade modem when moving into production. In this section we will explain how to connect a Nokia GSM to Sms 4Domino. More detailed information is available at Nokia's web site. Connection of other modems will be similar.
Sms4Domino Help Test the communication with the GSM. Click on the Diagnostics tab and click the Query Modem button. In this example the Nokia 6070 was identified. In case you get no response you could lower the communication speed with the modem.
Sms4Domino Help The GSM is now ready to be used with Sms4Domino. Additional resources Nokia quick installation guide: Nokia_Conn_cable_driver_installation_eng.
Sms4Domino Help Clickatell Sms service provider Sms service providers are an alternative to physical modems . In general they offer much higher throughput than a GSM modem. However, if you use Sms4Domino for sending alerts in case of a network failure, you should not use the network under test for sending Sms messages. Sms service providers offer different API's for sending/receiving SMS messages. Smslib always uses the HTTP(S) interface and can only be used for sending SMS messages.
Sms4Domino Help (of course you should replace USERNAME, PASSWORD, APIID, PHONE, MESSAGE with valid parameters). The destination phone number must be written as an international numer without the leading + or without the leading 00 (e.g. specify 32474963333 for a number in Belgium). Within a minute you should receive the Sms. Additional resources Clickatell HTTP API guide: Clickatell_HTTP.pdf . The first pages describe how to register and how to obtain the API identifier.
Sms4Domino Help Decide on the architecture Sms4Domino may be deployed in different configurations. However the program, as the name implies, always require the presence of a Domino server. This document describes a single instance configuration. Running the Sms 4Domino program as a server add -in Sms4Domino is a Java program. The program should run continuously. As Domino agents are limited in execution time it is not possible to run the program as an agent . Sms4Domino may run as a Domino add-in task.
Sms4Domino Help The GSM modems are attached to the workstation. The configuration database must be installed on the Domino server. This set-up does not depend on the JAddin program. However there is no integration with the Domino logging, no possibility to use the remote Domino console and supplying the Notes password via the command line may be less than ideal.
Sms4Domino Help Installation of the databases TheSms4Domino software is shipped as a set of two Domino databases : the Sms4Domino template and the help file. The template is a common template that must be used for all Sms4Domino related databases. The files may be delivered on a CD, by e-mail or may be downloaded from the Internet. The Sms4Domino template database is distributed as a Notes template file (.ntf). The help database is distributed as a standard Notes database file (.nsf).
Sms4Domino Help You could be prompted for the creation of a cross-certificate in your address book. Click No. You may adapt the ACL of the template to conform to your local standards. Use the Notes client to copy the template to the Domino server. The template on the workstation is then no longer needed. Create a configuration database from this template. The database must be stored in the data directory or a subdirectory on the Domino server. The title and file can be any valid name.
Sms4Domino Help ECL warnings. Use the Notes client to copy this database to the Domino server. The copy must be stored in the data directory or a subdirectory on the Domino server. The file name can be any valid name. The database on the workstation may be deleted. (In the help document Application profile settings -> General settings you will learn how to make a link between the Sms4Domino configuration database and the help database). Modify the ACL of the database.
Sms4Domino Help ACL Settings of the Sms 4Domino configuration database This database is the central point for the application. It contains all configuration settings and eventually queues of Sms requests, accounting data, ... This database should not be accessible by unauthorised users. It should get the same level of protection as the Lotus Domino® directory. Access to the application is controlled by access levels and roles in the ACL .
Sms4Domino Help - 47 -
Sms4Domino Help Installation of the runtime files Sms4Domino is a Java program that may run as a server add-in or as a standalone program. The program depends on some open source libraries (see the document About this database in the current help file). All code has been packaged in a few jar files Sms4Domino.jar and the jar files of the open source components. Java must be able to communicate with the GSM modems over the serial COM ports. One dll file is required.
Sms4Domino Help Notes. Notes .ini settings Most of the run time parameters for the Sms4Domino software are specified in Lotus Notes® documents in the configuration database. However, when Sms4Domino is started, it must know where to find the configuration database. This is achieved by two mandatory notes.ini settings. When Sms4Domino is running as a server add-in the notes.ini of the server must be modified. When Sms4Domino is running as a stand-alone program the notes.
Sms4Domino Help Sms4DominoConsoleHeight=500 - 50 -
Sms4Domino Help Application profile settings The application profile contains a few settings that are common to all Sms 4Domino instances. The profile document is accessed via the System -> Application Parameters entry in the menu outline. This document is mandatory and must be created by the database administrator. You need manager level access to create such a profile. Procedure 1. Open the Sms4Domino configuration database. 2. Select System -> Application Parameters in the navigator.
Sms4Domino Help Instance configuration settings Most of the instance related parameters of the Sms4Domino software are specified in the instance profile in the configuration database. There should be exactly one instance document per Sms4Domino instance. It is required to stop and restart Sms4Domino in order to make the modifications to the instance configuration visible to Sms4Domino. Every running Sms4Domino program is identified by a unique Instance ID. This ID is a hierarchical name.
Sms4Domino Help - 53 -
Sms4Domino Help Sms4 Sms 4Domino Server Settings This section contains global settings that are used by the Sms4Domino instance. Parameter Autostart server Purpose When Sms4Domino is launched, either as an addin or as a standalone program, it is ready to accept console commands. (The Help command displays a list of available commands ). However the Sms server is not yet started by default. This allows the administrator to launch some test probes on the modems.
Sms4Domino Help addresses. An alert may be mailed to 0, 1 or more valid mail addresses. The alert does not contain the text of the Sms. It is used to inform the Sms4Domino administrator that some unroutable SMS has been received. Should the SMS be kept in the Sms4Domino database. Doing so gives the Sms4Domino administrator the opportunity to read and forward the SMS manually. What should be the apparent sender of the mail that forward the received SMS or alert message.
Sms4Domino Help between commands minimum delay between two commands for the same Sms4Domino remote for the same target instance is specified. instance Default value: 10 seconds. Console commands When the current Sms4Domino instance x performs least cost routing to another Instance y (target instance) all listed console commands will be issued on the Domino server that holds the configuration database of the current instance. This is a multi-valued field. Separate values by newline.
Sms4Domino Help access to the Internet is not always available. In case a proxy server is used the proxy parameters are defined here. All Clickatell gateways share the same proxy settings. If no Clickatell gateway is used the settings are not relevant . Consult your network administrator for the proxy values. Proxy type Select a value from the list Direct connection - no proxy is being used HTTP(S) proxy Socks V4 or V5 proxy IP address IP addressof the proxy server.
Sms4Domino Help SmsLib Settings Sms4Domino runs on top of the open source SmsLib library (available at smslib.org). Parameters of SmsLib are documented on the web site smslib.org. For convenience reasons the documentation has been copied into this help document. SmsLib parameters are normally defined via java properties files . In a Domino environment administrators prefer to define parameters in Notes fields on Notes documents.
Sms4Domino Help Default: 1 000 ms SERIAL_RTSCTS_OUT If set, RTS/CTS will be enabled for outbound serial traffic as well . Useful for some types of phones Default: false QUEUE_RETRIES The retry count of the background queue manager for a message failing to be sent out. After this retry count, the queue manager will stop trying sending this message. Default: 3 times AT_WAIT This is a delay value, used after some AT commands. The value is in milliseconds.
Sms4Domino Help MASK_IMSI When true, the IMSI of the phone's/modem's SIM is not reported nor included in the logs (safety reasons). Default: true CONCURRENT_GATEWA When true, SMSLib will try to start all defined gateways concurrently (to speed up Y_START start up time). When false, gateways start one after the other. Default: true DISABLE_CMTI When true, SMSLib will try to disable all unsolicited inbound notifications. Most modems do not implement the unsolicited notifications correctly.
Sms4Domino Help Gateway definitions Sms4Domino uses SmsLib for sending and receiving SMS messages. Each individual communication channel (e.g. serial modem) is defined via a Gateway document in the configuration database. Without at least one active Gateway document Sms4Domino will not be able to start. Sms4Domino supports different gateway types (called Gateway Family): serial modems, IP modems, Internet SMS service providers, ...
Sms4Domino Help Click on the action button New Gateway or double click on an existing Gateway document. Select the kind of gateway that you would like to create. This cannot be changed. Consult the release notes and verify what Gateways families are supported by the current release . Gateway document settings The settings are grouped in two sections: general settings that are required for all gateway families and specific settings that relate to the selected gateway family .
Sms4Domino Help Used by instance: select the instance from the list of known instances. The selected instance will use the gateway. Gateway family: the selected gateway family. This value cannot be changed. The gateway family defines how the computer is connected to the GSM network. o Serial modem gateway: modem (recommended) or GSM phone connected via a (virtual) COM port to the computer. Read the help document on connecting a modem to the computer.
Sms4Domino Help - 64 -
Sms4Domino Help Serial Modem Gateway documents A Serial Modem Gateway document is required when a GSM modem is connected to the server via a serial port (COM port). The physical connection may be USB, Bluetooth or using a RS-232 cable. In production environments only the RS-232 connection should be used. The other connections are less stable and require additional configuration settings . In this document we assume the modem is connected via a RS-232 cable to a serial COM port.
Sms4Domino Help - 66 -
Sms4Domino Help IP Modem Gateway documents IP modems are serial modems that are connected via a serial-to-ethernet convertor. Some modems may have a build-in convertor, others require a separate box. Sms4Domino sends and receives the same AT commands but uses TCP/IP to communicate with the modem. Before configuring this kind of modem gateway document you should have tested the modem and configured the serial-to-ethernet convertor.
Sms4Domino Help - 68 -
Sms4Domino Help Clickatell Gateway documents Clickatell is a SMS service provider . Sms4Domino uses the HTTP(S) protocol to send SMS messages via Clickatell. You must have a valid Clickatell account and sufficient credits . The machine where the Sms4Domino program is being executed must have HTTP(S) access to the Internet. This connection may be direct or via a proxy server . Proxy server settings are configured in the application profile.
Sms4Domino Help Test Gateway documents A Test Gateway provides a low cost way for evaluating the software without incurring a cost from the phone company. Outbound test gateways pretend to send a Sms and may generate a transmission failure from time to time. Inbound test gateways pretend to receive a Sms message from time to time. In production environments test gateways will not be used.
Sms4Domino Help - 71 -
Sms4Domino Help Stub Gateway documents SmsLib, the communications package on which Sms4Domino relies, throws an error if no gateway has been defined. To avoid this unpleasant situation Sms4Domino uses a Stub gateway in case no other gateways are active. A Stub gateway is inbound only and will never receive a message. It has no other practical use.
Sms4Domino Help Interface definitions All communications between Sms4Domino and the end users is done via Interfaces. There should be at least one active interface in the system. Sms4Domino supports different interface types (called Interface Family): Notes mail message, HTTP, folder monitor, ... Interfaces may be outbound - sending SMS messages from Domino to the rest of the world - or inbound - receiving SMS messages from anywhere in the world.
Sms4Domino Help Click on the action button New Interface or double click on an existing Interface document. Select the kind of interface that you would like to create. This cannot be changed. Consult the release notes and verify what Interface families are supported by the current release . Interface document settings The settings are grouped in two sections: general settings that are required for all interface families and specific settings that relate to the selected interface family .
Sms4Domino Help General settings Interface id: Unique id of the interface. All logging and accounting is based on this id. Interface description: this free text field is only used by the administrator for documentation purposes. Used by instance: the Sms4Domino instance that uses the interface. Interface family: the selected interface family. This value cannot be changed. The interface family defines how end users or systems present their requests for sending Sms messages to the Sms4Domino application.
Sms4Domino Help - 76 -
Sms4Domino Help Notes Mail Interface documents Notes Mail Interface documents provide a means to end user and systems to send Sms messages by simply sending an email. Sms4Domino extracts the text and destination from the mail and delivers it as one or - in case the text is larger than the max size of a single Sms - more Sms messages. Requests for sending Sms messages are created by sending an e-mail to @@ or @.
Sms4Domino Help control database. o You cannot define more than 1 Notes Mail Interface for the same database (in this version of SMS4Domino there may only be one Notes Mail Interface) o The database must be based on the Sms4Domino template and not on the standard Domino mail router template. If needed, a custom made template could be used.
Sms4Domino Help Special precautions for implementing Lotus Traveler ® SMS push: Sms4Domino may be used for implementing IBM® Lotus Notes® Traveler Auto Sync via Sms (Short Message Service) push. This setting may greatly increase a device's battery life. By default, Lotus Notes Traveler® maintains a TCP connection between a device and server that allows both to stay in sync with each other.
Sms4Domino Help automatic deletion. Zero value implies automatic deletion after sending the Sms. o Delivery report requested: it could take some hours or days before the delivery report is received. Negative value implies no automatic deletion. Zero value implies automatic deletion after sending the Sms.
Sms4Domino Help Phone number preprocessing Introduction End users may specify the phone number in different ways. The number 0474 96 11 11 in Belgium (country code 32) may be written as +32474961111 0032/(474) 96 11 11 0474-96.11.11 For the correct matching of future inbound SMS messages with the outbound SMS it is essential to convert SMS numbers to a standard representation. Sms4Domino uses the international number format as a standard representation.
Sms4Domino Help We will now explain all the available settings in the Phone number processing section of the mail interface document. Local country code: the automatic convertion logic needs to know the local two-letter country code. When the user specifies a local number (e.g. 0474961111) it will be converted into + (e.g. +32474961111). The list of country codes is maintained by www.iso.org.
Sms4Domino Help 0411. So it will reject the local number 0411961111. However we cannot guarantee that Google's knowledge will remain up to date. This option could prove to be too restrictive. Manual convertion may be performed as a next step. It is configured as a set of filters (0 to 10 filters). Each filter will act on the result of the previous one # ad hoc filters: specify the number of filters that will be used Each filter is based on Java regular expressions .
Sms4Domino Help Destination restrictions: in this section you specify regular expressions for the patterns that are allowed (e.g. only sms to the local country -> ^\+32.*) or that are rejected. More than one pattern may be specified. In case no pattern is specified the test is not performed. The regular expressions are easy to write as we know that the phone number is now in the international format.
Sms4Domino Help Inbound SMS processing Sms4Domino presents all received Sms messages to every interface linked to the Instance . Each interface decides if the Sms can be received. If none of the interfaces is capable of handling the inbound Sms, the Sms is processed according to the settings in the Instance configuration document.
Sms4Domino Help We will now explain all the available settings in the Inbound SMS processing section of the mail interface document. Fixed routing: if disabled Sms4Domino does not look at the fixed routing documents when an inbound Sms has been received. Automatching: Sms4Domino creates an Auto-matching Inbound Routing document each time a SMS is sent. These documents are only created and consulted if auto matching feature has been enabled.
Sms4Domino Help be at least Minimum count delta % percent higher than the Outbound SMS count in all other conflicting Auto matching routing documents. o Warning message: text that gets appended to the mail. It may be usefull to append "Warning: it was not clear who should get this Sms. If the Sms is not for you please try to forward it to a more appropriate person.
Sms4Domino Help Optional agent preMailDelivery The Sms4Domino database contains a pre-mail-delivery agent called preMailDelivery .
Sms4Domino Help Inbound Route definitions Inbound route documents describe how a Sms received from the GSM network should be processed. In this release inbound Sms messages may only be delivered via email to a Lotus Notes® user . In case automatching has been enabled in the mail interface document, Sms4Domino creates automatically Inbound Route documents. These may be complemented by fixed route documents. Fixed route documents have precedence over the auto matching route documents.
Sms4Domino Help o Only Enabled routes are used by Sms4Domino. o Interface ID. The routing document will only be used by the specified id . o Weight. The routing documents are processed in descending weight order. o Type: auto matching route of fixed route o From - route to: a route specifies that all SMS messages received from a specified phone number should be mailed to the specified Notes user. Phone numbers are expressed as regular expressins.
Sms4Domino Help regular expression. The number is matched against the phone number of the SMS. This number is formatted as a international number without punctuation. (e.g. +32474957714). Leave the field empty to suppress the test on the phone number. Received via gateway: Inbound SMS messages enter the Sms4Domino system via a gateway (typically a GSM modem). Specify all gateways that match the current route. Leave the field empty to suppress testing the gateway.
Sms4Domino Help Specific settings for Auto Matching route documents The conflicts handlers must know when the route document was last used and how many times it has been used. Last outbound Sms: when a outbound Sms is sent the first time from Notes user John to GSM 1234567 the Auto Matching route document is created. If the same John sends a second Sms to GSM 1234567 the time stamp is updated.
Sms4Domino Help Instance Routing Rules Instance Routing Rule documents are the basis for implementing least cost routing between multiple Sms4Domino instances. But even in a single instance Sms4Domino configuration you must create at least one Instance Routing Rule document. Examples on configuring least cost routing are described in separate document in this help file . The settings in the Instance Routing Rules documents are read into memory when Sms4Domino starts.
Sms4Domino Help The configuration on the routing will send the SMS at the lowest cost. The cost is not expressed in read $ or € but in units. The cost is composed of three components: The Telco operator cost. Sending an SMS to a local number may cost 10 units but sending an SMS to a foreign country may cost 50 units. The replication cost. If a request for sending a SMS is received by the Belgium instance there is a time delay for replicating the request to the France instance .
Sms4Domino Help Mandatory Instance Routing Rule document for single instance configurations In a single instance Sms4Domino configuration there is no possibility to do instance routing . Yet, Sms4Domino requires a valid Instance Routing Rule configuration . Rule name: LOCALDELIVERY Status: Active Sms received by instance: * Number pattern: .
Sms4Domino Help Example 1 Instance FRANCE/Sms4Domino By preference this instance should send all SMS messages to +33 numbers. The operator cost for sending another country is 10 times higher than sending to France. The cost for sending to France is 5 units. Instance BELGIUM/Sms4Domino By preference this instance should send all SMS messages to +32 numbers. The operator cost for sending another country is 5 times higher than sending to Belgium. The cost for sending to Belgium is 10 units.
Sms4Domino Help transmitted by the France instance. This will involve a replication of the request to the France server. Suppose Jeanne - an employee working in France - deposits his mail for John@+158995255@Sms in the Sms4Domino database in France. Sms4Domino France finds 2 rules that match the number pattern: France_foreign and Belgium_foreign. Both have a cost of 50 units. Sms4Domino knows that replication takes time and server resources . So preference is given to the local instance.
Sms4Domino Help Example 2 In this example we focus on load balancing. There are two instances, both located in Belgium. The instances are part of a Domino cluster; replication is within seconds. As both instances are located in Belgium they have the same operator cost for sending messages. We would like to try to balance the load over the two servers. Instance INSTANCEA/Sms4Domino This instance should send all SMS messages that are posted by the router in the local configuration database.
Sms4Domino Help Remark: the queuing cost is based on the queue length that is published in the heartbeat records. Sms4Domino tries to keep the info up to date but the info will always be slightly outdated.
Sms4Domino Help Configuration of Domino mail topology End users will mostly use the Notes mail interface to send Sms messages . They compose a mail message using the Notes client or iNotes and address it to John@0474778899@Sms The @ character is recognized by the Domino router as a Domino domain separator. Domino must know how to route the mail to the foreign domain called Sms. The Sms4Domino configuration database must be specified as the gateway server and file.
Sms4Domino Help Deny mail from domains 6. The names of Domino domains that are not allowed to route messages to this foreign domain. Leave this field blank to allow any domain to route mail through the local domain to the foreign domain . Click the Mail Information tab and complete these fields , and then save the document: Field Enter Gateway server name The name of the Domino server running the gateway software . Gateway mail filename The gateway's mail file name.
Sms4Domino Help Single Instance Sms 4Domino topology In this example the Sms4Domino configuration is located on server Server1/Sms4Domino.
Sms4Domino Help If needed, create connection documents to route mail from Server0/Sms4Domino to Server1/Sms4Domino and another connection document for routing in the opposite direction.
Sms4Domino Help Multiple Instance Sms 4Domino topology In this case there is more than one Sms4Domino configuration database. This may be for improved reliability or to benefit from least cost routing . Case 1: two clustered Domino servers in the same country The communication costs are the same for both servers. End users should not know that there is more than one Sms4Domino server. They just send their mail to name@number@SMS in order to send a SMS message.
Sms4Domino Help Clustered Domino servers reside in the same Notes Named Network. No connection documents are required for mail routing.
Sms4Domino Help We could implement the same solution as in case 1. However SMS messages for France could be deposited by the router in the Sms4Domino config database in Belgium. As an alternative we could train the users located in France to send their mail to name@number@SMSFrance in order to send a SMS message. The users located in Belgium are instructed to send their mail to name@number@SMSBelgium in order to send a SMS message.
Sms4Domino Help Logging settings Sms4Domino makes use of the open source library log4j for all logging. This framework provides a very flexible and performant logging system. Plenty of background information is available on the Internet. We recommend you to visit the web site http://logging.apache.org/log4j/1.2/. As an administrator you have almost full control over what info should be logged and what should be the output for the logging. We will describe some typical configurations in this help document .
Sms4Domino Help Sms4Domino environment the console is either the Domino console and log.nsf (when Sms4Domino is running as an add-in) or the Sms4Domino Swing console (when Sms4Domino is running as a standalone program). The third line is required to propertly format no Ascii characters . The fourth line specifies how the output should be formatted. We are using a standard PatternLayout. This layout requires additional information that is supplied on the fourth line .
Sms4Domino Help Click on the action button New Logging Configuration or double click on an existing Logging Configuration document. Logging Configuration settings Used by Instance: every running Instance requires a specific logging configuration document Title: just for documentation Status: All active logging configuration documents for the user are concatenated into a single properties file. The resulting properties file is then used as the log4j.properties file.
Sms4Domino Help - 110 -
Sms4Domino Help Conversion Pattern The conversion pattern specifies what information must be logged for an event. Example log4j.appender.console1.layout.ConversionPattern=%d{HH:mm:ss,SSS} %m %n The conversion pattern is written to the right of the = sign. It is composed of literal text and conversion specifiers. Conversion specifiers start with the % character followed by optional format modifiers and a conversion character. The conversion character specifies the type of data, e.g.
Sms4Domino Help Console Appender settings A console appender should be used to route all logging information to the Sms4Domino console. When Sms4Domino runs as a server add-in the console is integrated with the Domino console and the Domino log.nsf. A typical console appender is configured with following four configuration entries (assuming the appender is called console1 as defined by log4j.rootLogger=INFO, console1) log4j.appender.console1=org.apache.log4j.ConsoleAppender log4j.appender.console1.
Sms4Domino Help File Appender settings File appenders are used to route all logging information to one or more files . FileAppender appends log events into a file. The file is specified by the File option . If the file already exists, it is either appended or truncated depending on the value of the Append parameter. RollingFileAppender acts as a FileAppender but will create a new file when the log file reaches a certain size specified by the MaxFileSize parameter .
Sms4Domino Help added to the filename. The pattern may include single quoted text. This may be usefull for specifying the file suffix log4j.appender.file1.DatePattern='.
Sms4Domino Help Using multiple appenders When running Sms4Domino as a server addin it may be sufficient to use one ConsoleAppender. All historical logging will be stored in log .nsf automatically. However, when Sms4Domino runs as a standalone program, you may want to use a ConsoleAppender and a FileAppender. This is accomplished by specifying more than one appender for the rootLogger log4j.
Sms4Domino Help Server license settings All license settings are found via System -> Licenses. Sms4Domino looks at regular intervals for the presence of a valid license . Each running istance requires a specific License document. License information is stored, as a signed human readable text string, in a license document. The Sms4Domino configuration database could hold multiple license documents (in order to support multi instance deployments). The validity of a license may depend on multiple factors .
Sms4Domino Help . License document settings Servername - Instance Id: Sms4Domino looks for an active license document that corresponds to the servername where the configuration database is stored and to the Instance Id that runs the Sms4Domino code. The Instance Id is specified in Notes.ini.
Sms4Domino Help - 118 -
Sms4Domino Help How to amend a license ? License files may contain an expiration date. At some point in time it could be necessary to renew the license. Procedure 1. Sms4Domino runs based on the settings of the current active license document 2. A new license document may be configured for the same user and server. The status of this document should be "Inactive" 3.
Sms4Domino Help Error messages during license validation When Sms4Domino is started the license is validated . In case of a missing license following messages are logged on the Domino console 21:12:16,580 SmsServer is ready to be configured and started . TRACE 21:12:16,586 Current configuration violates license conditions : 0 active license documents found for user-server XXXX-YYYY. Should be 1. FATAL 21:12:16,588 SMS4Domino is NOT started FATAL Application will close in 15 seconds.
Sms4Domino Help Principles of operations Sms4Domino may run as a Domino server addin or as a standalone program. End users compose Sms messages by sending an e-mail to e.g; John@0474876212@sms. This can be done from the Notes clients, iNotes®, Lotus Traveler®, ... The Domino router knows how to deliver the message to the Sms4Domino configuration database. Sms4Domino picks up the mail, converts it into a SMS message and transmits it via one of the gateways.
Sms4Domino Help Run Sms 4Domino as a Domino server addin Java programs may be executed under control of the RunJava task. The Java Virtual Machine that is shipped with Lotus Domino® (typically stored in a subdirectory of IBM\Lotus\Domino\jvm) must be used, as Sms4Domino depends on some cryptographic API's that are shipped by IBM® and are not part of Oracle's® jvm. The run-time files must have been correctly detached to the local file system . You should strictly follow the installation instructions .
Sms4Domino Help under control of RunJava, not all Java objects will be removed from memory. It is better to stop Sms4Domino by issuing the tell runjava quit command. Sms4Domino may be launched when Domino starts by modifying the notes.ini file of the server.
Sms4Domino Help Run Sms 4Domino as a standalone program Sms4Domino may run as a standalone program. This Java program makes local Domino calls . The computer must satisfy following conditions Lotus Notes® 8.x client must have been installed on the computer. Notes.ini of the Notes client must contain a valid entry keyfilename= . It is recommended to test the Notes setup by launching the Notes client and opening the Sms4Domino configuration file on the server.
Sms4Domino Help The bottom area is used to enter commands. Use the arrow-up and arrow-down keys to scroll through the command history. The Windows may be resized. Sms4Domino stores the window size in the notes.ini. Sms4Domino is terminated by entering the quit command. Should this fail - and this could happen when some low level I/O cannot be interrupted - the program is stopped by clicking the x in the top right corner of the console window.
Sms4Domino Help Sms4 Sms 4Domino commands When Sms4Domino has been launched the program is ready to accept commands entered via the console. Sms4Domino is not yet ready to send SMS messages unless the autostart parameter was specified in the application profile . The Sms4Domino console keeps a history of entered commands. Use the up and down arrow to scroll through the list.
Sms4Domino Help Remark: it is recommended to configure Sms4Domino in auto-start mode. This avoids having to enter the start command.
Sms4Domino Help Pause command Syntax: pause Purpose: a started server may be paused. It will halt the polling of the interfaces. Resume command Syntax: resume Purpose: a paused server may be resumed. It will continue to process all Sms requests Quit command Syntax: quit Purpose: terminates Sms4Domino.
Sms4Domino Help Syntax: refresh logging Purpose: when a Sms4Domino setting is changed (gateway, interface, application profile, license) it is necessary to quit and launch Sms4Domino. The exception is the configuration of the logging. After making a change this command may be used.
Sms4Domino Help Accounting records Each time a Sms message was successfully sent or received an accounting document is written . The document contains information about the end user, the date/time of the request, the number of characters, the estimated number of required Sms messages, the gateway and the interface. The creation of accounting records may be enabled/disabled in the Instance Configuration document.
Sms4Domino Help Aggregated accounting documents are required in case restrictions on the volume must be imposed (planned for a future release). Tip: the administrator should delete the detailed accounting documents when they consume too much disc space.
Sms4Domino Help Volume by date report This view shows all available accounting records sorted by date . Every interface may have its own definition of user. For the mail interface the user is the name in the from field of the mail.
Sms4Domino Help Volume by user report This view shows all available accounting records grouped by user and month . Every interface may have its own definition of user. For the mail interface the user is the name in the from field of the mail.
Sms4Domino Help Volume by gateway report This view shows all available accounting records grouped by gateway and month .
Sms4Domino Help Volume by interface report This view shows all available accounting records grouped by interface and month .
Sms4Domino Help Aggregated accounting report This view shows all available aggregated accounting documents .
Sms4Domino Help Health Monitoring Every running Sms4Domino instance updates a health document at regular times (defined in the Instance Configuration document). This health document is used by the Instance Router when determining the Sms4Domino instance that should send the Sms. All Health documents are available in the view System -> Running Instances. In above print screen taken at 16:02 we see that two instances are up and running (Server0 and Server1).
Sms4Domino Help Instance Id: there should be exactly one document for every running instance Session Id: When Sms4Domino starts it generates a random session id. This allows Sms4Domino to detect the invalid configuration where multiple Sms 4Domino instances using the same instance id. Configuration database: Server!!filename of the configuration database used by this instance. For information only. Username: Username that runs this Sms4Domino instance. For information only.
Sms4Domino Help Purpose The Notes Mail Interface is the main path for end users to send SMS messages. Using their standard Lotus Notes® mail client (or any other client that is capable of sending mails via the Domino server) they send mail to a foreign domain that is linked to Sms4Domino. The mail is processed by Sms4Domino, converted into a SMS message and transmitted via any of the available gateways.
Sms4Domino Help Formatting the recipient 's mail address The most important thing the end user should know is how to address a mail message in order to deliver it as a SMS message. The procedure is slightly different for mail delivered to the server via the Domino router versus mail delivered via the Domino SMTP listener task . Addressing format when using the Lotus Notes® client, Traveler®, iNotes®, ... Lotus Notes® uses the @ character to specify the Domino domain name.
Sms4Domino Help Sending a Flash SMS message A Flash SMS appears directly on the phone's screen, instead of the 'Inbox'. Its an useful alternative to normal SMS when you want to catch the recipients attention immediately. The recipient may have the option of 'Saving' the Flash SMS to his 'Inbox'. Before sending the message the user should specify the Delivery options . Sms4Domino will send high importance mail messages as a Flash SMS.
Sms4Domino Help Delivery confirmation Some GSM networks may return a delivery confirmation when SMS was delivered to the recipient's phone. The mail setting Delivery report = Confirm delivery or Trace entire path is recognized by Sms4Domino. When the operator returns the delivery confirmation or failure to Sms4Domino, this confirmation is converted in a mail message and returned to the sender.
Sms4Domino Help Background information Delivery reports may not work as expected. All elements involved are described here. Configuration of the Sms4Domino mail interface document The mail interface document must have enabled the receipts of status delivery reports How is the delivery report matched to the outbound recipient The end user sends a SMS message to the number 12345678. The GSM network assigns a sequence number to this Sms message.
Sms4Domino Help Processing by the mail interface Mails delivered by the Domino router into the configuration database appear in the view Notes Mail Interface -> SMS box Only the SMS recipients are displayed in the column Recipients. Sms4Domino polls every x seconds the SMS.box. When a new mail is discovered all recipients are extracted. For every recipient a new response document is created. The response documents are visible in the view Notes Mail Interface -> Operation.
Sms4Domino Help The initial status of the SMS is To be sent. In multi-instance configurations the documents may need to replicate first to another Domino server. After a few seconds and when a gateway becomes available the transmission is started. The status is then Transmission in process .
Sms4Domino Help The Sms response document may be opened (in read mode). All information related to the SMS is displayed and will be updated in real time by Sms 4Domino.
Sms4Domino Help After some time the documents in the view are deleted by Sms4Domino.
Sms4Domino Help Reroute Action Sms4Domino assigns the Instance that is responsible for sending the Sms at the moment the mail is received. In some cases the administrator may want to assign another Instance. The reroute action could also be used to send a Sms a second time. Open the view Notes Mail Interface -> Operation. Select the documents that must be rerouted. Click the action Reroute. Select one of the defined Sms4Domino instances.
Sms4Domino Help Manually routing received Sms messages When a Sms message is received from the GSM network it is normally routed based on the available Inbound Routes. However, when no valid route is present or when multiple conflicting routes are found the Sms message is kept by Sms4Domino in the configuration database. All undeliverable inbound Sms messages may be found in the view Operations -> Received - no match. Select the inbound Sms messages that should be routed. Click the action Forward.
Sms4Domino Help Supported platforms and configurations Supported operating systems The current version of Plug-in for Lotus Domino® has been tested on Windows/2003 and Windows/2008 for Intel platforms in 32 and 64 bit mode. The software requires a Domino R8 server. For performing administrative actions a Windows based Lotus Note®s clients , version 7 or 8, must be used. Modems that have been tested with Smslib Sms4Domino is based on the open source library Smslib.
Sms4Domino Help Smslib currently supports BulkSMS - all regions - (http://www.bulksms.com) and Clickatell ( http://www.clickatell.com). Please note that the above mentioned bulk sms operators are supported only for outbound messaging. SMSLib implements an HTTP/HTTPS interface with them.
Sms4Domino Help How to use Sms 4Domino in IBM® Lotus Notes® Traveler environments Following info has been copied from IBM's® documentation: You can set IBM® Lotus Notes® Traveler to use SMS (Short Message Service) mode for Auto Sync, which may greatly increase a device's battery life. Note: This topic does not apply to Apple devices. By default, Lotus Notes Traveler maintains a TCP connection between a device and server that allows both to stay in sync with each other.
