Home

Sms4Domino - Help V1.0

1. System Application Parameters Gateways Inbound routes Interfaces Licenses Logging config Runtime files 1 document selected A Office Network License document settings e Servername Username Sms4Domino looks for an active license document that corresponds to the servername where the configuration database is stored and to the Lotus Notes username or servername executing Sms4Domino When Sms4Domino runs as a server based add in on the server that holds the configuration database both servername and username specify the name of the server e Status active or not used There should only be one active license document for a given servername username combination e License data contents of the license file that was received at time of purchase The license file may be opened with a text editor However changing a single character will invalidate the signature License files without a valid signature will not be accepted by Sms4Domino The license file may contain wildcard settings When you receive the license file you must open it with a text editor e g Notepad select all text and paste the text in the field Text before the START LICENSE header or after the END LICENSE footer is ignored during the validation of the license 73 Sms4Domino Help License IBM Lc File Edit View Create Actions Tools Window Help BFZelD Ssoxetste ABD J FSCVTG He Fe BRE License SMS4Domino s
2. COMport COM5 H Baudrate 11520 Databits 8 pS jp O SPSR noe E A 500 ier Send Close La eA a len 0 lt LF gt 0OK len 3 lt LF gt a Asci HEX i Logtothefiley Clear C mmm mm 3 COM is open Mode gt Manual Source gt String Putty http www putty 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 exe program Sms4Domino Help Basic options for your PuTTY session Specify the destination you want to connect to Serial line Speed COM4 115200 Connection type Raw enet Rogn SSH Seral Load save or delete a stored session 6 SSH Leas 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 14 Sms4Domino Help H SSH Specify additional settings for the serial connection click on Connection gt 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 The modem should respond with OK to the AT command 15 Sms4Domino Help e EP COM4 PuTTY Si Sms4Domino
3. Databases The main database is the configuration database It contains the application profile the license file and the configuration documents for the gateways and the interfaces The database is based on the Sms4Domino template The database must be located on a Domino server and not on a workstation In most cases requests for sending Sms messages are created via Lotus Notes mail messages received by the Notes mail messages interface The Domino routing configuration requires the definition of a foreign domain document The foreign domain documents defines a gateway file name This could be the configuration database or a separate database The database should always be based on the Sms4Domino template We recommend using a separate database Domain SMS Basics Restrictions Mail Information Calendar Information Comments Administration Gateway servername M Gateway mail file name sms4domino db1 nsf Sms4Domino may generate accounting documents These documents provide a view on the Sms volume over a period of time for a user a gateway or an interface The accounting information may also be used to block a user from sending more Sms messages The 35 Sms4Domino Help accounting documents may be stored in the control database or in a separate database The database is based on the Sms4Domino template We recommend using a separate database 36 Sms4Domino Help Installation of the databases TheSms
4. Replacement options 1 Replace All Matches m Comment Remove all from the phone number that is not a digit or a sign Each filter i is based c on Java regular expressions The matching pattern tests if the phone number contains a specified pattern If so the matched substring is replaved by the replacement pattern Replacement options specify if only the first match or all matches must be replaced The comment field is not used by Sms4Domino Working with Java regular expressions require some Java knowledge The interface document contains some commonly used filters Quick filters Set filter number 1 5l Remove non digits Remove space point comma Replace international prefix by Validation when all Sendaiaealon steps have ben applied the resulting number should ahde egular expression specifies the format for a a valid number 69 Sms4Domino Help Validation Validation pattems 710 10 S Zero or one regular expressions The phone number should match the pattern If not the end user will receive an error message by mail If none specified all numbers are considered valid More validation will be done by the modem and or the GSM network Optional international prefix at least 10 dig s Comment Only the optional international prefix followed by sequence of digits is allowed a cal country gt 32 or that are rejected M
5. 18 40 21 980 SmsServer is ready to be configured and started Thread 5 be sms4domino server SmsServer 263 TR 18 40 21 980 SmsServer is ready to be configured and started Thread 5 be sms4domino server SmsServer 263 TR 18 40 22 097 Sms4Domino started as stand alone program Thread 5 Sms4DominoStandalone 191 INFO 18 40 22 097 SMS4DOMINO a solution for sending SMS messages Consult hitp iwww sms4domino eu for more inf elp List of available commands help display this text start read the seitings and start the server pause pause inbound and outbound polling resume resume a paused server quit shutdown of Sms4DominoAddin status display the status of the sms server ports list all Known Serial ports probe lt portname probe the given portname case sensitive at different speeds refresh logging refreshes the logging settings from the config database a nc 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 In case the Domino server is stopped or the network connection becomes broken Sms4Domino will not be able to continue will log errors to the console and in most cases must be restarted in order to recover from the failure
6. Recommended value 30 seconds Outbound polling interval The outbound direction is defined as from Sms4Domino to the GSM Outbound queue depth network Requests for sending SMS messages may come from different sources Every source is implemented by an interface The interface places the request into an internal queue Sms4Domino polls the queue every outbound interval seconds Interfaces may accelerate the polling process by sending a signal to the polling process As a consequence it is allowed to have a rather large outbound polling interval Recommended value 300 seconds Sms4Domino pushes outbound SMS requests into the queues managed by SmsLib This parameter specifies how many outbound requests may be at any time in the SmsLib queues In order to have an optimal throughput the 45 Sms4Domino Help Low priority time zone Accounting records Accounting database queue should not be left empty when there are still outbound SMS requests present within the interfaces Pushing too many requests into SmsLib may result in a memory overload In case of a server crash the messages will be pushed again into the queue when Sms4Domino starts again Recommended value 2 the number of outbound modems outbound gateways Low priority SMS messages are sent after high and normal priority messages but may be sent at any time during the day This setting is not used in the current release Each time an outbound SMS message has
7. Trying at 19200 Device not found no OK received response Trying at 28800 Trying at 33600 Trying at 38400 Device not found no OK received response Trying at 56000 Trying at 57600 Device not found no OK received response Trying at 115200 Device not found no OK received response e port was probed Ports command Syntax ports Purpose displays the list of all known serial ports If your port is not listed then it cannot be used by Sms4Domino Modems connected via USB that are mapped to a virtual COM port may remain invisible for Sms4Domino elp display this tex start read the settings and start the server pause pause inbound and outbound polling resume resume a paused Server quit shutdown of Sms4Domino status display the status of the sms server ports list all known serial ports probe lt portname probe the given portname case sensitive at different speeds refresh logging refresh the logging settings from the config database fports JAll known serial ports COM1 COM4 COM5 COM7 COM8 COM9 COM10 Refresh logging command 97 Device not found java lang RuntimeException javax comm UnsupportedCommOperationException Unsupported bitra Device not found java lang RuntimeException javax comm UnsupportedCommOperationException Unsupported bitre Device not found java lang RuntimeException javax comm UnsupportedCommOperationException Unsupported bitre Device
8. e g Name 873663 sms The mail message is converted by Sms4Domino into an outbound SMS Delivery reports are returned via mail to the sender of the mail o Test interface an interface that never generates a request for sending Sms messages This kind of interface has no practical purpose e Interface priority a higher number means a higher priority he highest priority interface is polled first for outbound SMS requests Inbound SMS messages received from the modem are presented first to the highest priority interface When two or more interfaces have the same priority they are polled in a non deterministic way e Interface flow Specify what kind of messages may be generated by delivered to the interface o Inbound SMS message received from the GSM operator o Outbound SMS message generated by the interface o Status Delivery Report notifications received from the GSM operator as a feedback on a previous outbound message e Interface availability only Active interfaces are used by Sms4Domino Remember to restart Sms4Domino after a parameter change e Comment free text field 62 Sms4Domino Help IHF SSII GII ALD IFE totta Interface documents are used to configure a source of outbound SMS messages andor a destination for inbound SMS messages All interfaces are read into memory when Sms4Domino is launched When Moditying a setting a restart of the Sms4Domino server is required Only used for documentation Note
9. 0 56 16 bytes 32 time ims TTL 128 Reply from 16 6 56 166 bytes 32 time ims TTL 128 Ping statistics for 16 6 56 166 Packets Sent 4 Received 4 Lost z loss Approximate round trip times in milli seconds Minimum ims Maximum 3ms Average ims 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 27 Sms4Domino Help 10 0 50 100 The server 10 0 50 100 at NeedPassword requires a username and password Warning This server is requesting that your username and password be sent in an insecure manner basic authentication without a secure connection Remember my credentials 28 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 Enter the new address in the Networking section 29 Sms4Domino Help G VIG http 10050 O B X 2 Web Configuration Utility Ethernet Serial Server TCP IP To configure network settings of Ethernet Serial Server After saving configuration you have to restart the device to make the settings effective DHCP L Obtain an IP automatically IP Address
10. COM port name e COM speed this speed must correspond to the speed that the modem is using Some modems may operate at multiple speeds It is recommended to test the communication to the modem at the specified speed via a test program see the help document Choice and installation of the modem e Manufacturer model communication between the computer and the modem is based on AT commands Most modems are using the same set of AT commands Some modems deviate from the standard Specify Generic if your modem is not listed e PIN code the PIN code of the SIM card in the modem Sms4Domino may lock the card if a wrong Pin code is specified Sms4Domino has no tools to reset the Pin code 53 Sms4Domino Help gt General settings wv Specific settings for Serial modem gateway Serial modem is directly connected to the computer via a COM port either physical or emulated e g USB Directions E inbound W Outbound InDound gateway may receive SMS messages Outbound gateway is used for sending SMS messages COM port COMS sim Emutated COM ports are not always recognized by the software Consult the manual for solutions itis recommended to connect the modem to a physical COM port COM speed 7415200 2E bps Communication speed between the computer and the serial modem ianutacturer model Genenc sE Select the closest from the list Entering a value Matis not listed will result in the genenc modem driver deing used If your modem is not
11. Help Aggregated accounting report This view shows all available aggregated There may be one document for per gateway per interface and per user muno BFVsOlID sorxeeee DAE ZFSTse Re SeQarACG Sms4Domino Key X Gateways 19032012 0903 2012 2102 2012 2201 2012 21012012 1003 2012 21012012 21012012 1 document selected CA Office Network 105 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 In the following documents we will explain the options for the end user and provide some insight in the processing by Sms4Domino 106 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 itas a SMS message The procedure is slightly different for mail delivered to the server via the Domino router versus mail delivered via the SMTP listener Addressing format when using the Lotus Notes client Traveler iNotes Lotus Notes uses the character to specify the Domino domain name The administrator is free to choose the name of the forei
12. Help Initial configuration of the Cinterion MC 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 Trying to connect the unknown modem to the serial to Lan convertor and then trying to talk to the modem over the LAN is not recommended This document assumes you are using Putty for communicating with the modem Following steps will be executed e Establish communication with the modem It may be necessary to guess the baud rate e Reset the modem to the factory defaults e Set the required modem parameters e Save the parameters to non volatile RAM After each reboot of the modem these settings will be loaded automatically into memory e Verify the PIN code of the SIM card Establish communication with the modem Find in the office a computer with a COM RS 232 port Determine the identifier of the COM port In most cases this will be COM1 The Windows device manager lists all known ports a YF Ports COM amp LPT Communications Port COM1 High Speed PCI Serial Port COM4 High Speed PCI Serial Port COMS5 Standard Serial over Bluetooth link COM10 gt Standard Serial over Bluet
13. Of course is is possible to run multiple instances of Sms4Domino on different machines each using a dedicated configuration database Not all gateway families that are supported by SmsLib are available for being used by Sms4Domino Currently we recommend connecting an industrial modem via a serial cable to a COM port Multiple modems may be connected to the same machine All modems must be connected to the machine where Sms4Domino is running Sms4Domino Help 30 minute installation guide The installation should be straightforward for a Lotus Domino system administrator Before you begin e Acquire one or more industrial grade GSM modems e g Cinterion MC55iT and a SIM card During the development of Sms4Domino we tested many different modems Although they should all implement the same set of AT commands we have experienced subtle differences in the way this is done Sms4Domino support for modem related issues is therefore available for this modem only e Connect the moden s to the serial port s on the computer Consider installing a PC card with multiple serial ports It is also possible to connect the modem via a serial to ethernet convertor directly to the LAN This setup is documented in a separate help document e Test the communications between the PC and the GSM modems Windows provides some basic test tools g Phone and Modem Standard 56000 bps Modem 2 Properties General Modem Diagn
14. configuration of log4j is done via properties files text files comparable to notes ini Sms4Domino makes use of Notes documents to define the configuration of the logging These documents are read by Sms4Domino and converted into log4j properties The log settings may be modified at any time The Sms4Domino command refresh logging reads the updated configuration from the configuration database and modifies the active log4j settings accordingly Some log4j concepts e logger applications that use log4j direct all logging output to one or more named loggers The logger name space forms a hierarchical system that starts at the top with the root logger When an application produces some log info it specifies the name of the logger and the severity or log level of what is being logged Possible log levels are FATAL ERROR WARN INFO DEBUG o TRACE e appender log4j directs the output of the log statements to one or more appenders that have been defined for the logger Typical appenders write the logging info to the console a file the Windows event manager Domino logging More than one appender may be linked to a logger Multiple loggers may share the same appender e layouts the events logged by an application may contain plenty of information time and date of the event Java class name method name and line number where the event occurred text of the event Layouts give you the possibility to format the output In all following
15. 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 Outbound interfaces may or may not accept the returned delivery reports Interfaces have a priority Sms4Domino will poll all interfaces in order of priority for Sms messages to be sent As such a high priority interface could block a lower priority interface from sending Sms messages When two interfaces have the same priority the behaviour of Sms4Domino is not deterministic The settings in the Interface documents are read into memory when Sms4Domino starts If you need to make changes to any of the settings you will have to quit and start the Sms4Domino application Procedure to create an Interface document e Open the Sms4Domino configuration database e Select System gt nterfaces in the navigator The right part of the screen displays all defined interfaces o Only Enabled interfaces are used by Sms4Domino The enabled interfaces are listed first in descending order of priority Interface ID must be unique All Interface related logging uses this id Priority A high numeric value means a high priority Family O O O 90 Flow interface may be inbound or outbound Outbound interface
16. e ee8AeGR v Priority Submit Time Notes Mail Interface 07 02 13 47 SMS box Operation John Doe 32474961145 sms gt Status To Reports System The initial status of the SMS is 7o be sent After a few seconds and when a gateway becomes available the transmission is started 112 Sms4Domino Help Sms4Domino IBM Lot Create Actions Tools Window Help z Oneness Home x Sms4Domino x Jegan A A Recipients Notes Mail Interface 07 02 13 47 Wim Stevens Anthos SMS box 07 02 13 53 Wim Stevens Anthos John Doe 32474961 Operation John Doe 32474961145 sms gt Status To Reports System 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 113 Sms4Domino Help ba i OMS Trom mal 1 File Edit View Open amp Iarann SoOorxeeteteeqe Status Recipient Number Text Status report required Importance SMSC Ref Number UUID Gateway Message date Encoding Message class Dispatch date Message status Failure cause Ch fi Home Create Actions Tools Window Help E Sms4Domino Transmission OK John Doe 32474961145 sms 32474961145 Test message 2 Please call the office Normal 28 700addf6 4841 4a02 87f2 ef07173d2ccb SERIAL 07 02 2012 13 53 ENC7BIT MSGCLASS_NONE 07 02 2012 13 53 51 SENT NO FRROR 114 SMS fr
17. false CACHE_DIRECTORY java home QUEUE_DIRECTORY null 20 32 44 776 No inbound gateway has been configured 20 32 45 220 Queue directory not defined Queued messages will not be saved to filesystem 20 32 45 221 GTW SERIAL Starting gateway using Generic AT Handler 20 32 45 221 GTW SERIAL Opening COM5 115200 javax comm SerialPort implementation version 3 8 opyright c 1998 2009 Serialio com All Rights Reserved Serialio Library version 10 1 0 build 9218 opyright c 1996 2011 Serialio com All Rights Reserved jos name Windows 7 os arch x86 SerialPort class loaded jspWin javax will be used 20 32 52 022 GTW SERIAL GSM Registered to home network 20 32 52 053 GTW SERIAL MEM Storage Locations Found SMMEBMSR 20 32 52 103 GTW SERIAL Gateway started SMS server successfully started Pause command Syntax pause Purpose a started server may be paused It will halt the polling of the interfaces 95 Sms4Domino Help SMS4Domino ino sending SMS messages in a Domino environment probe lt portname probe the given portname case sensitive at different speeds refresh logging refresh the logging settings from the config database pause SMS server successfully paused Resume command Syntax resume Purpose a paused server may be resumed It will continue to process all Sms requests pause SMS server successfully paused esume SMS server successfully resume
18. gateways will not be used Specific settings for Test Gateway e Directions specify if the modem is used for sending SMS messages outbound and or receiving SMS messages inbound e Polling cycle a thread polls an internal queue for new outbound SMS requests every x milliseconds e Receive cycle only used fro inbound gateways One virtual inbound SMS message is received per receive cycle e Fail cycle If set to N then every Nth sent or received SMS message will throw an error or flag the outbound message as not sent Set to zero to disable failures Integer value e Outbound fail method flag as unsent or throw an error e Outbound duration Simulated duration for sending one SMS message The actual duration will be a random time between the two specified values 57 Sms4Domino Help Fite Edit Yiew Create Actions Section Tgols Window Help Sat a eo r IBFX lt elx20B9 B90 LFSC Be F GAE A Test gateway may De used for testing purposes It simulates the receipt of messages at random times it may also be used to send messages The modem just waits a random time The gateway aiso simulates fom time to time an error when receiving or sending messages Directions W indouna M Outbound Indound gateway may receive SMS messages Outbound gateway is used for sending SMS messages Polling cycle 75000 a msec A thread polls an intemal queue for new outbound SMS requests every x Detault value 500 msec Receive
19. not found java lang RuntimeException javax comm UnsupportedCommOperationException Unsupported bitre 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 elp display this texi start read the settings and start the server pause pause inbound and outbound polling resume resume a paused server quit shutdown of Sms4Domino status display the status of the sms server ports list all known serial ports probe lt portname probe the given portname case sensitive at different speeds refresh logging refresh the logging settings from the config database refresh logging ogging settings have been refreshed 4 Ill 98 Sms4Domino Help Accounting records Each time a SMS message was successfully sent 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 Creation of accounting records for inbound Sms messages is planned for a future release HFS IETA AA B FSI Accounting records are generates each Sme a SMS message has Deen received or sent recordes Accounting Fates are not AgCOU
20. prefer to define parameters in Notes fields on Notes documents Sms4Domino reads the settings from the application profile and translates them internally into SmsLib properties Parameter SERIAL_NOFLUSH SERIAL_POLLING SERIAL_POLLING_INT ERVAL SERIAL_TIMEOUT Purpose If true SMSLib will not call the flush system call upon writing to the serial port This should normally be left as false meaning that we need the flush call Set it to true for Linux RxTx and virtual ports where the flush call leads to errors Default false If false SMSLib will rely on the serial port interrupts to wake up and get incoming data If true if will create a separate thread in order to periodically poll the serial port for incoming data Set it to true only on Linux RxTx installations if you see that SMSLib behaves as if no modem is connected Default false This is the polling interval It has a meaning only when the SERIAL_POLLING is true i e SMSLib works in polling mode The value is in milliseconds The default value is a good starting point you may experiment with different values Default 200ms This is the master timeout set on the serial ports The value is in milliseconds Default 30 000ms SERIAL_KEEPALIVE_IN This is the keep alive interval The keep alive functionality in SMSLib TERVAL SERIAL_BUFFER_SIZE SERIAL_CLEAR_WAIT SERIAL_RTSCTS_OUT periodically pings the modem in order to keep the connection acti
21. refresh the logging settings from the config database tatus Server status STOPPED Start command Syntax start Purpose starts a stopped Sms4Domino server Once started the server will be processing requests for sending Sms messages Remark it is recommended to configure Sms4Domino in auto start mode This avoids having to enter the start command 94 Sms4Domino Help Server status STOPPED start 20 32 44 771 20 32 44 771 20 32 44 771 20 32 44 771 120 32 44 771 20 32 44 771 20 32 44 771 20 32 44 772 20 32 44 772 20 32 44 772 20 32 44 772 20 32 44 772 20 32 44 772 20 32 44 772 20 32 44 772 20 32 44 772 20 32 44 772 20 32 44 773 20 32 44 773 20 32 44 773 20 32 44 773 20 32 44 773 20 32 44 773 20 32 44 773 20 32 44 773 20 32 44 775 20 32 44 775 20 32 44 775 20 32 44 775 20 32 44 771 Effective smslib settings SERIAL_NOFLUSH false SERIAL_NOEVENTS false SERIAL_POLLING false SERIAL_POLLING_INTERVAL 200 SERIAL_TIMEOUT 15000 SERIAL_KEEPALIVE_INTERVAL 60 SERIAL_BUFFER_SIZE 16384 SERIAL_CLEAR_WAIT 1000 SERIAL_RTSCTS_OUT false QUEUE_RETRIES 3 AT_WAIT 200 AT_WAIT_AFTER_RESET 10000 AT_WAIT_CMD 1100 AT_WAIT_CGMS 200 AT_WAIT_NETWORK 5000 AT_WAIT_SIMPIN 5000 AT_WAIT_CNMI 3000 OUTBOUND_RETRIES 3 OUTBOUND_RETRY_WAIT 3000 WATCHDOG_INTERVAL 15 CNMI_EMULATOR_INTERVAL 30 MASK_IMSI true DISABLE_CMTI false HOURS_TO_ORPHAN 72 CONCURRENT_GATEWAY_START true DISABLE_CMMS true DISABLE_COPS
22. the time that SMSLib will give modem in order to attach to the GSM network The value is in milliseconds Default 5 000 ms This is a delay value representing the time that SMSLib will give modem after the SIM PIN initialization The value is in milliseconds Default 5 000 ms If CNMI fails SMSLib will launch a separate thread for periodically polling the modem for inbound messages and still act as an asynchronous reader Default 30 s This is the retry count defining how many times SMSLib will try to send a failing message After those retries message will be marked as failed Default 3 times The wait time between two attemps for sending a failed message Value is in milliseconds Default 3 000 ms This is the process interval of the Service Watchdog background thread The value is in seconds Default 15 s When true the IMSI of the phone s modem s SIM is not reported nor included in the logs safety reasons Default true When true SMSLib will try to start all defined gateways concurrently to speed up 48 Sms4Domino Help Y_START DISABLE_CMTI HOURS_TO_ORPHAN DISABLE_CMMS DISABLE_COPS CACHE_DIRECTORY QUEUE_DIRECTORY start up time When false gateways start one after the other Default true When true SMSLib will try to disable all unsolicited inbound notifications Most modems do not implement the unsolicited notifications correctly We recommend disabling them Default tru
23. to the LAN The serial server has following factory settings IP address 10 0 50 100 Subnet mask 255 255 0 0 Default gateway 10 0 0 254 DHCP client disabled User name admin Password lt null gt leave the password field blank Use a paperclip to push the reset button for a few seconds You will hear some beeps This resets the serial server to the factory default settings Configure the Ethernet port of your test computer with compatible IP settings E g 26 Sms4Domino Help r Internet Protocol Version 4 m CP IPv4 Properties i i e You can get IP settings assigned automatically if your network supports this capability Otherwise you need to ask your network administrator for the appropriate IP settings Obtain an IP address automatically 10 0 50 Subnet mask 255 255 0 Default gateway Obtain DNS s r address automatically Use the following DNS server addresses Preferred DNS server Alternate DNS server E Validate settings upon exit 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 r C Users gt ping 16 6 56 166 Pinging 10 080 50 100 with 32 bytes of data mReply from 16 6 56 19 bytes 32 time 3ms TTL 128 Reply from 16 6 56 19 bytes 32 time 2ms TTL 128 BReply from 16
24. 4Domino are located on the same server One or more modems are connected via COM ports to the Domino server End users and systems may send mail from different kind of workstations anywhere in the network Domino will route the mail to Sms4Domino To John 0474112233 Sms Domino Server Domino Server Pi Sms4Domino Domino i network N sms4Domino config N database Domino f Server p 9 f m ri iNotes SMTP li enabled client client f F PDA client GSM network As an alternative Sms4Domino may run on a Windows workstation The modems are connected to the COM ports of the workstation The configuration database resides on any of the Domino servers Sms4Domino Help Domino Server Domino Server Domino network Domino Server SMTP enabled client GSM network 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 database Not all Interface families have been implemented In the current release requests for sending a SMS must be mailed to Sms4Domino Only one Notes Mail Interface may be defined This implies that there is only one foreign domain document related to SMS messages
25. 4Domino 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 The databases may only be accessed by a Notes client and not by a web browser The current version of the template is 1 0 Allow design locking Y List in Database Catalog Categories Y Show in Open Application dialog Include in multi database indexing Do not mark modified documents as unread Mark parent note on reply or forward Inheritance Inherit design from master template Template name Refresh design on admin server only Y Database file is a master template Template name SMS4DOMINO List as advanced template in New Application dialog Copy profile documents with design Single copy template Multilingual Options Multilingual database Default language X Default region v Default sort order v Unicode standard sorting e Geta copy of the databases Unzip the files if required e Copy the template to your local Lotus Notes data directory By preference this should not be done on the Domino server but on a workstation of the administrator Do not forget to remove the read only attribute that
26. 610 0 50 110 Default Gateway 10 0 0 254 SubnetMask 255 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 Ce es t0050 9 86x 8 we contguicn niey ki Ethernet Serial Server LINK1 To choose specific working mode for COM port TCP Server _ TCP Client Enable _ Enable Enable 4660 2 Enable Source IP 10050101 2 10 sec 0 255 0 Disable 6 sec 0 255 0 Disable 30 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 Only the Sms4Domino server should be allowed to communicate with the serial server Enabled Yes Source IP specify the IP address of the Sms4Domino server Idle Time before sending TCP Alive packet Sms4Domino assumes the TCP IP connection remains open Enter 2 for 20 seconds TCP Inactivity Time in case of a
27. 856978 Sms4Domino mycompany com The sending server should be allowed to relay to the Sms4Domino domain via the reeiving server 107 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 very Delivery priori I Do not notify me if recipient s are running Out of Office I7 Do not expand personal groups Security Options Mood Stamp Bas l Encrypt I7 Save these security options as the default 108 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 Prevent copying I Auto spellcheck 7 Mark Subject Confidential I Do not notify me if recipient s are running Out of Office I Do not expand personal groups Security Options I Sign I Encrypt I Save these security options as the default When the operator returns the delivery confirmation or failure to Sms4Domino this confirmation is converted in a mail message
28. 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 SmsDomno BM Lotus Ne Exe p r yes ene Aters Toos insew kiip Tar x 4 HPF LOD SSxsyeo BAD ZLFSFw_V Be ee GAG Sms4Domino Temestano interface Remote 2003012 17 0808 wht saros 2oosan12 170757 rt enamas 20032012 1707 48 wrt k2a7ans1n4s 20092012 1707 9 wrt sazevepetas 20030012 170790 wrt sIQa7apnTNeS 20032012 170720 wrt paars 2003002 1707 4 w 32474011S 20030012 1707 02 Mer exaavapernes 20032012 170852 Mer ekaaTapsrn4s 20032012 1708 43 MF exemptus 20032012 17983 MFt saaarapatias 20032012 170424 mer pars 20019012 17001 vs Jaras 2002012 170602 saaros 2oonger2 170853 sasra nas 20032012 170544 32474051145 2002012 1705344 32474981945 20032012 170525 sees 20002012 170844 22474961045 20032012 170595 sunas 200a 170454 OUTONO ONTEN saaran SSSSSIESSSSSsssssseses PRS CT ee hs i rr a s E 20032012 170437 win Severaovmes OUTBOUNO CHIEN MFI 32474051145 ps 101 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 o IBM Lotus pens Home BB Sms40omino Heip Sms4Domino Sms4Domuno Help Sms4Domino Help AFFSIV SOx lt seseeGarCD 2FStRe Re He GAG Sms4Domino Y Wen
29. Help SM S4Domino s rh 20 19 51 988 Notes ini setting for SMS4DominoServer Syntrateacher Anthos 20 19 51 990 Notes ini setting for SMS4DominoConfigDB Sms4Domino db1 nsf 20 19 51 996 SMSLib A Java API library for sending and receiving SMS via a GSM modem or other supported gateways is sofiware is distributed under the terms of the Apache v2 0 License eb Site hitp smslib org 20 19 51 997 Version 3 5 0 20 19 51 998 JRE Version 1 6 0 20 19 51 998 JRE Impl Version 2 4 20 19 51 999 O S Windows 7 x86 6 1 build 7601 Service Pack 1 20 19 52 124 Sms4Domino started as stand alone program 20 19 52 125 SMS4DOMINO a solution for sending SMS messages Consult hitp iwww sms4domino eu for more inf elp ist of available commands help display this text start read the settings and start the server pause pause inbound and outbound polling resume resume a paused Server quit shutdown of Sms4Domino status display the status of the sms server ports list all known serial ports probe lt portname probe the given portname case sensitive at different speeds refresh logging refresh the logging settings from the config database 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
30. M R gt ate i s d dec 2012 RunJava JUM gt 3 RunJava JUM RundJava JUM AllowTe RunJava JUM AllowT Rundava JUM RunJava JUM Sms4Domino started as Java addin ta RunJava JUM 6 699 SMS4DOMINO a solution for sending RunJava JUM 8 6 699 Running delay 166 RundJava JUM 26 699 Notif yQueueManager running Sms4Domino commands are entered by typing tell Sms lt command gt 89 Sms4Domino Help TT tte ae Eee 984 Current license settings Username Antho syntraleacher fAnthos z 29 dec 2012 RunJava RunJave 2 Ji dec 2012 lomino rted as Java addin task DOMINO solution for sending SMS nes Munn Ng B ot ifyQueueM V Anthos sion for Vin Ste Antho F 5 sed Document 1 1 i va JU 1 i 1 i 1 JUM 18 18 15 843 Conmand will be executed on current thread of available conn help display this text start read the settings and start the erver pause pause inbound and outbound polling resu resume a paused server quit hutdown of Sms 4D sta display the f the sm server list A portna e gt portnane case sensitive at diff Fresh logging ref logging settings from the config datab Sms4Domino may be stopped by entering the quit command However if other tasks are running under control of RunJava not all Java objects will be removed from memory It is better to stop Sms4Domino by issuing the fe runjava quit command Sms4Domino may be launched when Domino starts by m
31. Manager level access at least editor level access is required e All roles enabled Recommended ACL settings for web users e No access the database has not been designed for web access e Noroles enabled 40 Sms4Domino Help 41 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 There is a specific file for 32 bit Windows and another for 64 bit Windows All runtime files may be found in the configuration database via the menu System gt Runtime files You need the DBAdmin role in order to access the page containing the runtime files Procedure 1 Open the Sms4Domino Configuration database 2 Select System gt Runtime files in the left navigation pane A page containing the jar and dll files opens Open the Windows 2003 Windows 2008 bit section Detach all files into the specified directories on the machine where the Sms 4Domino program will be running Pw 5 Close the window Runtime files Sms4Domino is a Java program that interacts with the hardware Some Java jar files and Windows dl
32. NENG FeCOrGs Should Ce deleted afer some tme Creation of Accounting records is opSonal However hey are required if usage restrictions weused CN Wim Stevens O Anthos CINTERION Cal OUTBOUND Success 2002 2012 17 04 46 50 ENCTEIT One SMS message may contain up fo 160 characters 7 D amp character encoding ts used In Case of 16 04 encoding only 70 characters M into one SMS message 1 32474961145 Message UUO 57 I0tA3I 8I5c 417 0306 20097 c45 00ee I gt Ofc Network The creation of accounting records may be enabled disabled in the Application Parameters document In parallel with the creation of detailed accounting records the system keeps also aggregated accounting records one Notes document per gateway interface and end user These documents contain the total volume per day for the corresponsing user gateway or interface 99 Sms4Domino Help Aggregated Ga see teway Opens Home HI Sms4Do AFVelIV Soxtse es L FSstWweeBe e Aggregated Gateway Accounting 2 7 2 39 33 90 284 270 a lt a Office Network 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 100 Sms4Domino Help Volume by date report This view shows all available accounting records sorted by date
33. 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 There is no need for additional servers or specialised skill sets Sms4Domino consists of one or more Lotus Domino databases In small environments the databases may be combined into one single database e Configuration database nsf that defines the gateways to the GSM network the interfaces that generate SMS requests the license the configuration of the logging and all required parameters e Accounting database nsf where historical data is stored Accounting records may be used to restrict people from sending SMS messages e SMS mailbox databases The Domino router stores SMS requests into this database Sms4Domino polls the database converts the requests into SMS messages and transmits them via one of the defined gateways e Sms4Domino run time program This Java program may run as a Domino server add in on a Windows based Domino server or as a standalone program on a workstation on which Lotus Notes has been installed Sms4Domino is build as a Java program on top of di
34. SteveasiAnthos 79 264 1 422 1376 v OUTBOUND 79 264 1 122 1376 gt Mar 27012 78 980 1 114 1 368 290022012 21 3215 41 29022012 21 30 36 20022012 21 28 57 29022012 21 0945 20022012 205200 20022012 20 4241 27022012 122240 27022012 104743 AHEHE bl lt b w b h i d d d oMa 102 Sms4Domino Help Volume by gateway report This view shows all available accounting records grouped by gateway and month Has eia TKK TY Feee ee Bare Sms4Domino 06 03 2012 19 0209 06 03 2012 19 01 59 06 03 2012 18 43 15 06 02 2012 18 4256 0603 2012 13 42 17 0603 2012 13 40 08 06 03 2012 11 20 04 06 03 2012 11 18 50 06 03 2012 11 18 41 06 03 2012 11 18 32 0603 2012 11 18 23 06 03 2012 11 17 24 06 03 2012 11 16 25 0403 2012 17 59 12 0403 2012 17 56 03 0303 2012 17 04 24 02022012 14 57 09 0202 2012 14 57 00 0303 2012 14 27 02 1D xt at ob wb mb od od od od ob mt wh oh wh od ot ob ob mt od 1 document selected a Office Network 103 Sms4Domino Help Volume by interface report This view shows all available accounting records grouped by interface and month 4Domino Help Sms4Domino x 2 ID S9xseeeGBaReGR 2ZFSstoe Re Be BAG Sms4Domino 1i 20022012 21 3215 20022012 21 30 35 20022012 21 28 57 2900272012 21 09 45 20022012 20 52 00 20022012 20 4241 2722012 122240 27022012 10 47 43 HHE LT 1 document selected lt A Office Network 104 Sms4Domino
35. ages from GSM modem Inbound polling interval Purpose When Sms4Domino is launched either as an addin or as a standalone program it is ready to accept console commands The He p 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 By setting the Autostart server parameter to enabled the Sms server is started automatically as soon as Sms4Domino is launched In production environments this should be the normal mode of operations Values e Enabled this is the recommended value e Disabled GSM modems may keep a list of all outbound SMS messages in their internal memory When this memory is full the modem may refuse to accept further messages Sms4Domino may delete the Sms from the memory of the modem after transmission Values e Enabled this is the recommended value e Disabled The same message will be received multiple times from the modem The inbound direction is defined as from the GSM network into SMS4Domino Sms4Domino is based on SmsLib for sending and receiving Sms messages SmsLib places inbound SMS messages received from the GSM network into an internal queue This queue is polled by Sms4Domino every nbound interval seconds Setting a value too high may result in end users complaining about late reception of their SMS messages Setting a value too low may impose unnecessary load on the server
36. al call prefix 005 International call prefix that ts most likely used by people using this mail interface when they dial an inmernational number The parameter is used dy the wizards to compute the best phone number processing filters See wiki article for a complete list Example specify 00 for most European countries or 011 for US Standards ation Mandaraisason is implemented either automaically or via a set of regular expressions and replacement string All expressions are evaluated one by one Expression n is using the output of expression n 1 In most cases is sufficient to use to automatic standardisation E enabled the phone number supplied by the user is converted automatically into an imermational format This assumes Mat all local cals are within the country specified dy the local country code parameter In addition the converted number may be automatically validated against a duilg in lst of known valid number pafiems This validation rejects short numbers e 9 1230 Office Network We will now explain all the available settings in the Phone number processing section of the mail interface document e 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 lt country prefix gt lt local number gt e g 32474961111 The list of country codes is maintained by www iso org e Local country prefix th
37. and returned to the sender New Reply lt lReplytoAlly Foward fv f Displaywy Q Morey To John Doe Company i Bcc Subject Delivery report Delivery status DELIVERED gt 00 Succesful Delivery Message was received on 02 02 2012 12 54 00 CET Intended recipient 32474961145 Original message example SMS 109 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 Interface flow Inbound V Outbound MV Status delivery report The end user sends a SMS message to the number 12345678 The GSM network assigns a sequence number to this Sms message A few minutes later the delivery report is received by Sms4Domino This delivery report contains the sequence number and the phone number where the Sms was delivered The sequence number is only 8 bits wide So there are only 256 distinct sequence numbers In heavily used environments Sms4Domino may find more than one outbound Sms with the same sequence number A better match is achieved by combining the sequence number with the recipient s phone number However this match may fail because the phone nunber in the delivery report could be different from the phone number in the outbound Sms E g the delivery re
38. ase e g sms box must be linked to the domain The Notes mail message interface reads the mails from the foreign domain mailbox and sends them out as SMS messages In order to use the Notes Mail interface a foreign mail document must have been configured in the Domino directory The procedure is explained in detail in the Domino help file A short description is included in the Sms4Domino help file Inbound SMS messages are converted into a Domino mail messages and may be delivered by Notes mail to a user Sms4Domino currently uses two systems to determine the destination for the Sms e Fixed routing all SMS messages received from GSM number lt gsm number gt are route by mail to the mail address lt recipient gt e Auto matching this is best explained by an example Assume John sends a SMS via Sms4Domino to Paula Paula 0475321825 sms When Sms4Domino receives a SMS from Paula s GSM within a given timeframe Sms4Domino assumes that it is a reply for John and will send an e mail to John However if Paula is very popular and receives Sms messages from John Bill and David When a reply is received from Paula Sms4Domino is not able to determine the destination The Sms is kept in the system and should be forwarded manually Specific settings for Notes Mail message e Database server amp filepath Name of the server filepath of the sms box o Leaving both fields empty corresponds to the control database being used as sms box This is
39. ation 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 Anew license document may be configured for the same user and server The status of this document should be Inactive 3 When the new license file has been received and loaded into the license document the administrator should e Modify the status of the current active license document to Inactive Save and close the document e Modify the status of the newly created license document to Active Save and close the document e Restart Sms4Domino 75 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 In case of an error in the signature the logging becomes 21 15 30 894 SmsServer is ready to be configured and started TRACE 21 15 31 016 Unexpected error during validation of signature Stack trace follows ERROR java security SignatureException invalid encoding for signature java io OException Sequence tag error at com ibm crypt
40. been transmitted an accounting record may be generated Accounting records may be used for internal billing processes and give management a detailed view on the use of the server The detailed accounting records are further aggregated into aggregated accounting documents These aggregated figures may be used not yet implemented in order to impose restrictions on users for sending further SMS messages Values e Generate accounting records this is the recommended value e No accounting records Accounting documents if enabled are created in the configuration database or another database Either way the database must be based on the Sms4Domino template Specify the filepath relative to the Domino data directory where the database resides The database must be located on the same server as the configuration database Values e leaving the field empty implies that the configuration database is used for storing accounting records This is the mandatory setting for the current release e filepath e g Sms4Domino accounting nsf to specify a dedicated database 46 Sms4Domino Help SmsLib Settings Sms4Domino runs on top of the open source Sms Lib 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
41. ck the card if a wrong Pin code is specified Sms4Domino has no tools to reset the Pin code 55 Sms4Domino Help Gateway IBM otus Note AFSeIixt oB2 899 FETI eBt Se BARE gt General settings v Specific settings for IP modem gateway IP modem is connected to the computer via the LAN The modem must have a known IP address Directions E indound I Outbound Inbound gateway may receive SMS messages Outbound gateway is used for sending SMS messages IP address 192 168 0205 IP address configured in the modem This address must be reachable by Sms4Domino Specify the address as voxouwuox e g 192 168 2105 IP pon 46605 Port number to which the modem is listening R must be possible to open a telnet session to the port Manufacturer model Generic sE Select the closest from the list Entering a value that is not listed will result in the generic modem driver being used your modem is not specified you may try using the generic modem m ee PIN code 11115 if specified this pincode will be used to unlock the SIM card A Office Network 56 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
42. conds Esad SUS message tom C Subjed oniy The teat of he SMS massage is extracted rom the subject ine of Pe mail andor ne C Body orty untormatied Dody field of Pe mail 66 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 known 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 This is composed of the plus sign the country code 1 2 or 3 digits followed by the local number End users may specify a badly formatted number e g containing letters or too short In case of obvious errors the SMS request should not be routed to the modem but must be returned immediately as a non delivery failure The administrator may impose restrictions on the allowed destinations In the current release these restrictions are imposed at the level of the interface and will be applied to all users Details The preprocessing of phone numbers is executed in a number of consecutive steps e Automatic convertion to the international number format Optional reject of mall formed numbers The automatic convertion is based on the open source code of Google e Ad hoc convertion using a set of regula
43. cycie 740000 msec One virtual inbound SMS message is received per receive cycle Fail cyde 7400000 1 if set to N then every Nth sent or received SMS message will throw an error or flag the outbound message as not sent Set to zero to Gisable failures integer value Default value 0 oe Simulated dura on for sending one SUS message The actual duration will be a random time between the two specified values Default value 5000 10000 msec 58 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 Specific settings for Stub Gateway e Directions stub gateways are always inbound and cannot be set to outbound File Edit View Create Actions Section Tools Window Help pens QD A Home x Ml Sms4Domi Hi Sms4Domino x Sms4Domi FBFSsesiQ2 sexe etee AVTD iL FSPeewee Be Gateway gt General settings w Specific settings for Stub gatewa Stub gateways are inbound only gateways However they never receive any SMS message Directions Indound Outbound Value cannot be changed lt A Office Network 59 Sms4Domino Help Interface definitions All communications between Sms4Domino and the end users is
44. d Quit command Syntax quit Purpose terminates Sms4Domino It is recommended to issue the quit command before quitting the Domino server UTGOWN O status display the status of the sms server ports list all known serial ports probe lt portname probe the given portname case sensitive at different speeds refresh logging refresh the logging settings from the config database quit 20 37 06 369 GTW SERIAL Stopping gateway 20 37 06 391 GTW SERIAL Closing COM5 115200 20 37 06 391 GTW SERIAL Gateway stopped 20 37 06 592 Normal end 20 37 06 593 SmsServer successfully shutdowned Application will close in 5 seconds Probe command Syntax probe COM lt i gt e g probe COM5 Purpose test the communication with a modem via the specified serial port at different speeds The portname is case sensitive and should not contain the colon character Some modems do not react correctly when being probed at different speeds It is better to test the communication with the modem via an external program 96 Sms4Domino Help Device not found no OK received response Trying at 115200 Device not found no OK received response e port was probed probe COM5 Probing the port may take some time Wait for all results Trying at 1200 Device not found no OK received response Trying at 9600 Device not found no OK received response Trying at 14400
45. e This setting defines the age in hours after which SMSLib will treat a message part as orphaned Orphaned parts are parts of a big multipart message which are received alone and their sister parts were never received in order for the full message to be reconstructed Once a message part gets older than what the setting says the relevant notification method is called Default 72 hours The CMMS command Keep GSM Link Open is used to increase the sending rate but may cause instability on some modems It is set by default Default false The COPS command is used for network selection The default should suffice but you can disable the use of the command Default false The generic cache directory location used by SMSLib Default java home The cache directory used by the Queue Manager If left undefined the Queue Manager acts in a non persistent way If you set it to a path Queue Manager will save pending outbound messages i e queued messages and reload them between SMSLib invocations SMS4Domino uses its own caching in Domino databases There is no need for an additional queue directory Default undefined 49 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
46. e connected via a Masal COM port to the computer Test gateway a virtual gateway Mat allows you to test Me sofware without hang to pay De phone company The gateway sirmmuiates senang anc receipt of sms messages Stud gateway indownd Gateway that never receives any messages This kina of gateway is only used for internal purposes 7 Only the Actve are used by Sms4Domino The status is reported in real Se by he SMS server for all avatanie gateways The disphayed value may not be accurate if SMS 4Domino is not running For imemal use 52 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 The modem was tested and responded with OK to the AT command Specific settings for Serial Modem Gateway e Directions specify if the modem is used for sending SMS messages outbound and or receiving SMS messages inbound e COM port select the COM port from the list or enter the name of the port The name is case sensitive and should correspond to the name reported by Windows Do not specify the colon after the
47. e modem should respond with OK OK AT OK After the configured idle time the connection is closed automatically The same test could be performed using Putty The connection type must be set to Raw 32 Sms4Domino Help Basic options for your PuTTY session Specify the destination you want to connect to Host Name or IP address Port 10 0 50 100 4660 Connection type Raw Telnet Rogn SSH Seral Load save or delete a stored session 6 SSH eae Appendix Atop user guide SE5002 Serial Ethernet User s Manual V1 3 pdf 33 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 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 The program is started via the oad runjava Sms4DominoAadain console command case sensitive All input output between the Domino administrator and the program goes via the Domino remote console As a shortcut the program may also be started using the oad runjava Sms console command O amp 5 1 E E 5 ay D US gt D CS 27 61 2612 18 89 32 Chronos Full text indexer terminating gt
48. e must be before this expiration date e Release date of Sms4Domino The release date of the running Sms4Domino program must be before this release date e Number of Notes Mail Interfaces defined by the configuration database e Number of Test gateways defined by the configuration database A typical evaluation license that could be downloaded from the website grants everybody the right to run Sms4Domino with one Test Gateway and one Notes Mail Interface Procedure to create a license document e Open the Sms4Domino configuration database e Select System gt Licenses in the navigator The right part of the screen displays all defined license documents o Only Active license documents are used by Sms4Domino They have a green check mark o Servername when the configuration database is located on server x then Sms4Domino looks for a license docuemnt for servername x o Username when Sms4Domino runs under the credentials of user A then Sms4Domino looks for a license document for user A o License data indication if a license file has been loaded into the document 72 Sms4Domino Help 2 Sms4Domino IBM Lotus Notes mE Eile Edit View Creste Actions Tools Window Help l Open s A A Home E Sms4Domino Help Sms4Domino New License Notes Mail Interface Servername Username License Data Operations syntrateacher Anthos syntrateacher Anthos License data is present syntrateacher Anthos Reports TY 5 ALU aE L bm ALE
49. e pre configured actions for manual convertion depend on the knowledge of the country prefix 1 2 or 3 digits The list of prefixes is documented in a Wiki Article http en wikipedia org wiki List_of_mobile_phone_number_series_by_country e International call prefix some end users specify an international number as lt international call prefix gt lt country prefix gt lt local number gt e g 0032474961111 Some of the pre configured actions for manual convertion are using this field in order to convert this prefix to the sign e Standardisation e The automatic standardisation based on Google s code may be enabled or disabled The logic may be applied in any of the following flavors e Do not perform automatic convertion e Convert the number automatically e Convert the number automatically and reject numbers that are most likely invalid For example Google may know that phone numbers in Belgium do not start with 68 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 e 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 Standardisation Automatic Automatic convertion reject invalid numbers s ad hoc filters Matching pattern 1 F 40 94 a Replacement pattern 1 Fa
50. een the PC and the modem Sms4Domino will communicate with the modem at a configurable speed However Sms4Domino will communicate with following settings e Speed defined in the gateway document Modems operate either at a fixed bit rate or may recognize automatically the bit rate being used This auto bit rate recognition feature does not work if the speed is too high or too low Consult the documentation supplied with the modem 8 databits 1 stop bit no parity bit Flow control based on RTS and CTS When the modem is connected to the PC it is recommended to perform some basic communication tests There are different ways for doing this We explain a few of them Windows modem test Open the Windows control panel Click on Phone and modems Add a generic modem to the COM port COM5 in the print screen Sms4Domino Help 5 Standard Modem over Bluetooth link ans A a modem i Ki Windows will now try to detect your modem Before continuing you should 1 if the modem is attached to your computer make sure t is tumed on 2 Quit any programs that may be using the modem Click Next when you are ready to continue peseeesessssnsessansessensessnsnsessnsnssssssossssssessssssessesssessessssnsesssessesssnsnsssussesasenseseeeey Sms4Domino Help Select the manufacturer and model of your modem If your modem is not listed or if you have an installation disk click Have Disk Manufactur
51. emplate EB Trigger Happy Configuration 6 X File name sms4domino sms4domino ntf About Show advanced templates V Inherit future design changes e Modify the default ACL of the database Details of the ACL settings may be found in the document ACL Settings of the application e Some database properties for this database e When opened in the Notes client Open designated frameset Main7 e When opened in a browser Open designated page AccessForbidden e Full text index is not required e Copy the help file to your local Lotus Notes data directory By preference this should not be done on the Domino server but on a workstation of the administrator Do not forget to remove the read only attribute that may be present at the level of the operating system e Sign the database using the Notes user id of the administrator in order to avoid any future ECL warnings e 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 38 Sms4Domino Help profile settings gt General settings you will learn how to make a link between the Sms4Domino configuration database and the help database e Modify the ACL of the database The default ACL grants manager level access to all users Standard users sh
52. enated with the recipient s phone number The design of the view must be based on the vwwSMS_ByRefnrPhonenr view as defined in the 64 Sms4Domino Help Sms4Domino template Polling interval the Domino router deposits mail messages in the sms box of the SMS server The requests are converted into another format by a separate thread Specify the polling interval in seconds for this thread Extract SMS messages from SMS messages are text only The contents will be extracted from either the subject the unformatted body of the mail or the subject followed by the unformatted body of the mail It is also possible to specify a formula The formula is executed in the context of the received mail Some default formulas may be inserted by clicking an action Truncate to The resulting message is truncated to the specified size If lt 0 then no truncation occurs It is strongly recommende to specify some safety value Large messages may result in a multi message SMS Outbound SMS retention time when a delivery report failure or confirmation is received from the SMSC it must be matched with an outbound SMS Outbound SMS messages are deleted automatically Delivery reports received after this deletion will not be delivered to the end user The retention time parameters are expressed as positive integer multiples of the polling interval o Test every n polling intervals the test for outbound messages that must be deleted is performed eve
53. er Models Standard Modem Types EQ Standard 28800 bps Modem Atheros Eal Standard 33600 bps Modem Standard 56000 bps Modem EQ Standard PCMCIA Card Modem El This driver is digitally signed Tell me why driver signing is important Select the port s you want to install the modem on You have selected the following modem Standard 56000 bps Modem On which ports do you want to install t C Allports Selected ports The modem may be tested via the query tool under the Diagnostics tab 10 Sms4Domino Help Command Response ATQOV1E0 Success AT GMM MULTIBAND 900E 1800 AT FCLASS FCLASS 0 1 2 lt COM test program The next example is based on the Advanced Serial Port monitor evaluation version available on http www aggsoft com 11 Sms4Domino Help CEET File View Edit Options Datasource Mode Plugins Help A COMport COM5 H Baudrate 115201 Databits 8 m3 yy Paritytype None v Stopbits 1 v Auto delay C 500 A X v Send Open i Logtothefile Clear C mmmm _1 1 31 COMis closed Mode gt Manual Source gt String 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 12 Sms4Domino Help a Advanced Serial Port Monitor 4 3 2 build 1212 File View Edit Options Datasource Mode Plugins Help
54. erver requires a valid license Sie present in the configuration database The signed license Me authorizes the user to run the program for a given configuration The Bcense file ts obtained via the web site hit www smsd4doming ey Demo licenses are available Multiple license Gocuments may be present in the Gatabase Al startup SMS4Domino will look for a matching license document Specify the servername where the configuration database is located Specify the hierarchical usemame of the effective Notes user Mat runs He Sms4Domino program When running as a server addin program this is the servername When running as a Standalone program on a workstaton Mis is the username linked to the userid of the Notes client installed on the workstafion Adve Oniy active licenses are taken into account when SMS4Domino starts START LUCENSE The complete contents of the license fie must De pasted in Mis field Usemame Anthos Modifying the contents of the file will invalidate the electronic signature Servername SyntraTeacheriAnthos Expires 29 12 2012 ReleaseDateLima 31 12 2012 MaxinGateways 3 MaxOutGateways 4 AlowTestinGateway talse AdowTestOUGateway talse MaxtotesMailintertaces 3 START SIGNATURE 302002147 bas0cc95320a5a2e4a7 7I71430c3 10fd 8326786302146605805308I92 9940e490 418M3 T chdadstas END LICENSE cA Office Network 74 Sms4Domino Help How to amend a license License files may contain an expir
55. ess can be any valid Lotus Domino address The fixed routing documents are visible in the view System gt Inbound routes e Auto matching routing this automatic routing is based on the assumption that when person x sends an Sms to person y it is very likely that a reply from y should be routed to person x For each outbound Sms message Sms4Domino creates a auto matching route This document specifies that Notes user x has sent a Sms to number y When a inbound Sms is received all routing documents are consulted based on the sender s phone number Three outcomes are possible e No match the inbound Sms cannot be delivered e Single match in inbound Sms is routed by Domino mail to user x e Multiple matches for different users there is a conflict The Sms is stored in the configuration database view Operations gt Received no match Auto routing documents are removed automatically after a specified number of hours This action is performed by the main polling thread of the mail interface All settings are documented in the Interface document Fixed routing z Sms4Domino ties to use fixed routing first Auto matching j Sms4Domino creates an Indound Routing document each time a SMS is sent Validity period 120 minutes When John send a SMS to Jane then Jane must reply within this timeframe Later replies cannot be automatched Avalue lt 0 considers that all inbound routing documents are valid 1 hour 60 minutes 1 day 1 440 min
56. eters Gwi Stud gateway Stud gateway Gateways MCS IP mocem gateway LAN modem Serial modem gateway GSM connected Serial modem gateway Ingustna GSM 1 document selected e Click on the action button New Gateway or double click on an existing Gateway document 50 Sms4Domino Help 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 families Select the kind of gateway you would like to create Test gateway Stub gateway IP modem gateway Clickatell gateway BulkSMS gateway SMPP gateway i 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 General settings e Gateway id Unique id of the gateway All logging and accounting is based on this id e Gateway description this free text field is only used by the administrator for documentation purposes e 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 o Test gateway a virtual gateway that allows you to te
57. examples we will use the standard PatternLayout o0o000 Example log 4j configuration file Let us first have a look to a standard configuration file Remember that Sms4Domino will not use this way for configuring log 4j log4j rootLogger INFO console1 log4j appender console1 org apache log4j ConsoleAppender log4j appender console1 encoding UTF 8 log4j appender console1 layout org apache log4j PatternLayout log4j appender console1 layout ConversionPattern d HH mm ss SSS m n The first line configures the root logger All log events of level INFO should be written to the appender called console1 Automatically all log events of level WARN ERROR and FATAL will also be logged to the appender Log events of level DEBUG and TRACE will not be routed to the appender All loggers form a hierarchy The root logger is sitting at the top As we enabled the root logger all other loggers will automatically be enabled for the INFO WARN ERROR and FATAL level The second line configures the appender called console 1 The appender is based on a ConsoleAppender This is a standard appender that writes all output to the console Ina Sms4Domino environment the console is either the Domino console and log nsf when 77 Sms4Domino Help 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
58. failure of Sms4Domino the connection should be broken Specify 60 This value should be higher than the watchdog interval specified in the application profile SmsLib settings Following set of parameters correspond to the physical COM interface The settings must be the same as the ones that have been configured in the modem Alias Name for your own documentation Baud rate 57 600 this is the default for the Cinterion modem Parity none this is the default for the Cinterion modem Data bits 8 this is the default for the Cinterion modem Stop bits 1 bit this is the default for the Cinterion modem Flow control RTC CTS this is the default for the Cinterion modem Empty Serial Buffer Yes Data Packet Delimiter this parameters determines at what moment data received from the modem should be transmitted to Sms4Domino There is no fixed terminator character that applies to all responses The only acceptable data packet delimiter is based on the inter character time gap A value of 15 msec should be fine 31 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 Th
59. fferent well known open source packages e smslib Java toolkit for sending and receiving Sms messages http smslib org e log4j Java logging framework http logging apache org log4j 1 2 e JAddin Java toolkit for Domino Add In Server tasks http abdata ch JAddIn html e libphonenumber Google s phone number handling library powering Android and more http code google com p libphonenumber The open source packages are distributed under the terms of the Apache V2 license The code and the licensing terms are stored in the Sms4Domino template SMS messages are sent via one or more GSM modems connected to the server or workstations We strongly recommend using industrial grade modems connected via a serial COM port Only the Cinterion MC55iT modem is supported Sms4Domino has been developed on a Domino 8 5 platform on Windows The program depends on the Java run time environment supplied with Domino or Notes This must be at least version Please visit us at http www sms4domino eu for more information All your feedback is welcome Sms4Domino Help Revision history The version of the software is printed when the application is started Version 1 0 March 2012 0 1 January 2012 Sms4Domino Help 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 Sms
60. gn domain that corresponds to Sms4Domino Let s assume the foreign domain is called Sms4Domino The mail recipient should be addressed as name number foreigndomainname e g John Doe 0474965588 sms number foreigndomainname e g 0474965588 sms The first part name is only used as information to the creator of the mail It is not used at all by Sms4Domino The second part number is the phone number of the recipient The number is cleaned transformed and filtered by Sms4Domino What remains should be a valid number that is accepted by the GSM network The pre processing on GSM numbers is explained in a separate document The third and last part foreigndomainname is the name of the foreign domain linked to the Sms4Domino configuration database that was specified by the Domino administrator Example John Doe 32474856978 Sms4Domino Addressing format when sending mail via some SMTP client Mail addressing should follow the Internet standard RFC 822 The character is used to separate the local part from the Internet domain name Only one character is allowed in the address Domino uses the character to insert the Domino domain name into the local part of the address Suppose an application uses SMTP to generate mail messages via Lotus Domino The Domino SMTP listener accepts mail for the Internet domain name mycompany com When the application needs to send a SMS to 32474856978 the recipient s address will be John D0e 32474
61. guration file for using a RollingFileAppender assuming the appender is called file 1 as defined by og4j rootLogger INFO console 1 file 7 log4j appender file 1 org apache log4j RollingFileAppender use or as directory separator when specifying the file name log4j appender file1 File e folder example log Append parameter if true the logger will append to the file should it already exist log4j appender file 1 Append true The MaxBackupIndex option determines the number of previously rolled files to preserve If set to zero then no roll over occurs and the log file is simply truncated when it reaches MaxFileSize log4j appender file1 MaxBackupIndex 5 The MaxFileSize option takes a String value representing a long integer in the range 0 263 You can specify the value with the suffixes KB MB or GB so that the integer is interpreted as being expressed respectively in kilobytes megabytes or gigabytes Rollover occurs when the log file reaches MaxFile Size One log event will always be contained within one file log4j appender file1 MaxFileSize 100MB A typical configuration file for using a DailyRollingFileAppender assuming the appender is called file1 as defined by og4j rootLogger INFO console file 7 log4j appender file 1 org apache log4j RollingFileAppender use or as directory separator when specifying the file name log4j appender file1 File e folder example log Append parameter if true the l
62. happen when some low lever I O cannot be interrupted the program is stopped by clicking the x in the top right corner of the console window 92 Sms4Domino Help Sms4Domino 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 Help command Syntax help Purpose displays the list of known commands 20 19 51 988 Notes ini setting for SMS4DominoServer Syntrateacher Anthos 20 19 51 990 Notes ini setting for SMS4DominoConfigDB Sms4Domino db1 nsf 20 19 51 996 SMSLib A Java API library for sending and receiving SMS via a GSM modem or other supported gateways is soflware is distributed under the terms of the Apache v2 0 License eb Site hitp smslib org 20 19 51 997 Version 3 5 0 20 19 51 998 JRE Version 1 6 0 20 19 51 998 JRE Impl Version 2 4 120 19 51 999 O S Windows 7 x86 6 1 build 7601 Service Pack 1 20 19 52 124 Sms4Domino started as stand alone program 120 19 52 125 SMS4DOMINO a solution for sending SMS messages Consult http iwww sms4domino eu for more inf elp List of available commands help display this text start read the settings and start the server pause pause inbound and outbound polling resume resume a paused server quit shutdown of Sms4Domino status display the status of the sms server port
63. l files must be copied to the appropriate directories on the machine where Sms4Domino will be executed The files are available in this page and should be detached into the file system More detailed instructions are available in the help file v Windows 2003 Windows 2008 files Sms4Domino executable Jar file containing the bulk of the code used by Sms4Domino The same code Is used when running as a server addin or as a standalone program The file should be detached to all of following places e The jvmilidlent directory below the Domino directory 6 9 C Program FilesVBM Lotus Domino milibiext in case Sms4Domino runs as a server add in FA Office Network 42 Sms4Domino Help 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 ini of the Notes client must be modified The notes ini of the Domino server may be modified by editing the file directly However it is recommended to specify the settings in a configuration document in the Domino directory The notes ini of a workstation is edited using a plain text editor
64. like Notepad The list of available notes ini parameters is specified in following table The parameters are not case sensitive Some of the parameters are mandatory Parameter Purpose Sms4DominoConfigDB This parameter specifies the location of the Sms4Domino configuration database This database resides in the Domino data directory or one its subdirectories The parameter must be specified as a relative file name The parameter is case sensitive on some platforms e g Unix Example Sms4DominoConfigDB Sms4Domino configdb nsf Default value sms4Dcfg nsf Sms4DominoServer This parameter specifies the hierarchical name of the Domino server where the configuration database resides In case the parameter is not specified the filter assumes the database resides on the current server Example Sms4DominoServer Acme SVR Comp Validation of the license file is only possible if the configuration database is located on a Domino server Sms4DominoConsoleWidth These two parameters are only used when Sms4Domino is running as a Sms4DominoConsoleHeig stand alone program They define the width and height expressed in ht pixels of the console used for logging and entering commands The open console may be resized by the Windows user When Sms4Domino is stopped the current console size is saved into these two environment variables Example Sms4DominoConsoleWidth 1000 Sms4DominoConsoleHeight 500 43 Sms4Domino Help Applicati
65. load runjava Sms4DominoAddin 18 12 46 JUM Java Virtual Machine initialized 18 12 46 RunJava Started Sms4DominoAddin Java task 18 12 46 RunJava JUM Enter method addInStart Thread 5 Sms4Dominc 18 12 46 RunJava JUM Notes ini setting for SMS4DominoServer 18 12 4 RunJava JUM Notes ini setting for SMS4DominoConf igDB In order to run a Java program as a server add in command Sms4Domino makes use of the open source software JAddin http abdata ch JAddIn html This kind of integration has not been certified by IBM Till today we have not yet experienced any problems The GSM modems are attached to the Domino server The main advantage of this configuration is the integration of the input output with the Domino console and log nsf file It is possible to use the Domino remote console to interact with the program The program may be started using Domino program documents or notes ini settings Running the Sms 4Domino program as a standalone program Sms4Domino may run as a stand alone program on a workstation Lotus Notes must have been properly installed and configured on the workstation Sms4Domino will access the Domino server using the credentials of the current Lotus Notes user id defined in notes ini by the KeyFileName variable The password must be supplied as a start up parameter or the user id must have no password Sms4Domino will create a console for interacting with the administrator 34 Sms4Domino Help
66. may be present at the level of the operating system The ACL settings of the template grants full access to all users This may be changed according to your company policy settings e Sign the template using the Notes user id of the administrator in order to avoid any future ECL warnings This user id should have sufficient access rights to run Lotusscript agents 37 Sms4Domino Help You could be prompted for the creation of a cross certificate in your address book Click No e Use the Notes client to copy the template to the Domino server The template on the workstation is then no longer needed e 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 In the help document Notes ini settings you will learn how to tell Sms4Domino where to find this configuration database The license file that is required to run Sms4Domino is based on the server name where the configuration file is located Moving the configuration database to another server requires the presence of a new license file Title Sms4Domino configuration Cancel File name Sms4Domino config nsf cj Create full text index for searching Advanced Specify Template for New Application Server Local v EB News Articles 8 5 a EB Notebook 8 Pf Personal Address Book ope 6 SMS 4 Domino Template EB Sms4Domino Help T
67. n the Connection gt 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 E COM4 PuTTY 19 Sms4Domino Help Enter the letters AT followed by pressing Return The could be an echo of AT The modem should respond with OK ra Ss E If there is no respons from the modem you should verify your settings Reset the modem to the factory defaults The AT amp F command resets all modem parameters to the manufacturer defined profile The modem response should be OK The AT amp V command lists the current parameters Consult the Cinterion AT command guide for more info 20 Sms4Domino Help r EP COM4 PuTTY Sox 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 lt rate gt command Values of lt rate gt are 0 for autobauding 300 600 57600 115200 230400 The setting will not be changed by the above AT amp F command The current bit rate may be queried by the AT IPR command 21 Sms4Domino Help r COM4 PuTTY Le e 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
68. nLayout log4j appender console1 encoding UTF 8 log4j appender console1 layout ConversionPattern d HH mm ss SSS m _ n 82 Sms4Domino Help File Appender settings File appenders are used to route all logging information to one or more files e 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 e RollingFileAppender acts as a FileAppender but will create a new file when the log file reaches a certain size specified by the MaxFileSize parameter When creating a new file the current log file is renamed by appending a 1 to the filename Should this 1 file already exist it is renamed by changing the 1 to 2 The maximum number of files to keep is specified by the MaxBackupIndex parameter e _DailyRollingFileAppender acts as a FileAppender but will create a new file at a user chosen interval The file names will contain the date information A typical configuration file for using a FileAppender assuming the appender is called file 1 as defined by og4 rootLogger NFO console 7 file 1 log4j appender file 1 org apache log4j FileAppender use or as directory separator when specifying the file name log4j appender file1 File e folder example log Append parameter if true the logger will append to the file should it already exist log4j appender file 1 Append true A typical confi
69. ng The contigurabon of the logging is linked to the efectve SUS4Demino user Just tee Gocumertabon All ICPa logging CONDITION Gocumnerts toe he user are Concatensies into a single geopetes Sie The resulting gropertes file is hen used as the 1094 propertes fie Nis possible to Change the logos parameters whist he SUS4Domino Server is running Use the COMMING retesn logging to reload the lopging config log4j rootL ogge DEBUG console 1 filet See the heip Bie or NRE Mogging apache cegtogsy1 2 logt appender console l org apache logs ConsoleAppender The acdan buton below may be used to actvate normal logging of INFO appende console layout org PateenLayout messages to De Domino console ae aera seen Sonano amA dI Easa 888 Xm en Possibile log tevels FATAL ERROR WARN INFO DEBUG TRACE Set default for logging to console Set default for logging to console and fle J 80 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 category priority date thread name The format modifiers control such
70. no 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 Otherwise you will see security exceptions in the log file Sms4Domino is started by entering the Domino server command load runjava Sms4DominoAddin As a shortcut the following command produces the same result load runjava Sms The name Sms4DominoAddin or Sms is case sensitive JUM Virtual Machine RunJa Started RunJava JUM s b ini ting for SMS4DoninoServer Rundava JUM 6 6 5 stting for SMS4DominoConfigDB sms4do Rundava JUM P sib A Java API library for sending and re i RunJava JUM i t re is distributed under the terms of the Apache v2 RunJava JUM d ite http smslib org Rundava JUM 6 668 Version 3 5 0 RunJava JUM 18 668 JRE Version Rundava JUM JRE Impl Ver 4 RunJava JUM O S Windows 7 5 2 build 3796 RunJava JUM 9 Effective sns RunJava JUM 6 6 Auto start RunJava JUM F Delete mess fter processing true RunJava JUM s 6 684 Inbound int 24 RundJava JUM 6 684 Outbound interval RunJava JUM 18 6 684 Outbound queue depth 2 RunJava JUM 18 684 Current license settings Username finthos Rundava JUM n SyntraTeacher fnthos Rundava JUM ir 2 RunJava JU
71. ntro database E emet Men the datadase is found on the same server 33 the control database You cannot defne more than 1 Notes Mail intertace for the same Gatabase in this version of SMS4Domnino there may only de one Notes Mail interface This view contains af outbound SMS messages Design of the view must be based on the Mail view as defines in he Sms 4Domine template The view is processed from start to botom Octaut value Mar SMS server acks Me Sending of sms Messages in response documeENts Inked to the receives mail The response Messages are created in the sms box database Every outbound SMS message is identifed by a UUID This view lists ail outbound mais sorted by ULIO The design of he view must be Dased on the ywSMS Buig view as defines in the Sms4Domino template Detaut valve vwSUS_ByUd SLS By Retr Pronenr Viewname vwSlS_SyRetnrPhonenr Message delivery conftrmatens anc talures must be matched to a past outbound SMS message The match is based on the Reference Number received tom the SMSC CORCSIENMES WIN Ihe fecageents phone numar The design of he view must be based on the SMS BrRetyPRoners view as defined in he Sms4Domino temptate Octaut value vwS S_ByRetnPhonenr Polling interval 20 seconds The Comino router deposits mail messages in he sms dor of the SMS server The requests are Converted into another format by a separate read Specity the polling interval in Seconds for his read Detauk value 30 se
72. o provider SHA1withDSA engineVerify Unknown Source at java security Signature Signaturelmpl engineVerify Signature java 467 at java security Signature verify Signature java 287 at be sms4domino licensing LicenseSignature isValidSignature LicenseSignature java 88 at be sms4domino licensing License loadActiveLicenseFromDomino License java 174 at be sms4domino server DominoSmsServer lt init gt DominoSmsServer java 64 at be sms4domino server DominoSmsServer getInstance DominoSmsServer java 76 at Sms4DominoStandalone runNotes Sms4DominoStandalone java 154 at lotus domino NotesThread run Unknown Source 21 15 31 017 Current configuration violates license conditions Signature in license data is invalid User server XXXX YYYY FATAL 21 15 31 018 SMS4Domino is NOT started FATAL Application will close in 15 seconds The license will be checked at regular times to make sure the expiration date has not been passed 76 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 ogging 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 The
73. odifying the notes ini file of the server Look for the entry ServerTasks and add RunJava Sms at the end ServerTasks LDAP router RunJava Sms 90 Sms4Domino Help Run Sms4Domino as a standalone program Sms4Domino may run as a standalone program This Java program makes local Domino calls The computer must satisfy following conditions e Lotus Notes 8 x client must have been installed on the computer e Notes ini of the Notes client must contain a valid entry keyfilename lt filepath of the userid file gt t is recommended to test the Notes setup by launching the Notes client and opening the Sms4Domino configuration file on the server e The run time files must have been correctly detached to the local file system You should Strictly follow the installation instructions Otherwise you will see security exceptions in the log file Sms4Domino may be launched by executing following batch file The name Sms4DominoStandalone is case sensitive We assume that Lotus Notes has been installed in c program files x86 IBM Lotus Notes C cd program files x86 IBM Lotus Notes jvm bin java Sms4DominoStandalone In case the user id file is protected by a password you will be prompted to enter the password It is also possible to specify the password on the command line as a parameter C cd program files x86 IBM Lotus Notes jvm bin java Sms4DominoStandalone password The Sms4Domino console will be launched 91 Sms4Domino
74. ogger will append to the file should it already exist log4j appender file 1 Append true The DatePattern specifies when the rollover should occur The parameter should follow the conventions of the java text SimpleDateFormat class yyyy for yearly rollover yyyy MM for monthly rollover yyyy MM dd for daily rollover yyyy MM dd a for daily rollover at midnight and midday yyyy MM dd HH for hourly rollover The pattern is used to specify when the rollover should occur and what suffix should be HRHHHH 83 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 yyyy MM dd HH 84 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 rootLogger INFO console file1 The level of logging INFO in the above example is always the same for all specified appenders Should it be required to have a different level of logging for the console and file appenders you could specify the most verbose level of logging for the rootLogger and then filter the logging at the appender level In foll
75. ollowing text has been copied from the Lotus Administrator Help File 87 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 Of course it is also possible to create the mail message from non Notes environments For example a server monitoring program may detect a server failure and send a SMTP mail message to one of the Domino servers In this case the mail must be addressed to John 0474876212 sms company com The SMTP listener task accepts the message The part before the company com is interpreted as a Lotus Notes mail address where is used as a Domino domain separator End users may ask for a delivery report When Sms4Domino receives the delivery report from the GSM network it is converted into a regular mail and routed back to the end user In the following documents you will learn how to start Sms4Domino and how to monitor the operations 88 Sms4Domino Help Run Sms4Domino 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 Domi
76. om mail A le B x This document is created by the proces For every recipient specified in the Lotu created All details of the delivery process of the The document is deleted automatically Status of the delivery ofthis single SMS Possible values To be sent Transmission in process Transmission OK Fatal error Dead Retry later Received Recipient as specified by the creator of Should be formatted as name numbe This number has been extracted from t The text that has been extracted from ei truncated to the maximum allowed size A large text may be delivered in multiple Not all SMS service providers will hono Notes mail messages flagged as impi Message identification used in the com GSM modem or service provider This with the GSM number of the other party Unique ID used by SMSLib The gateway that will perform or has p For outbound messages this is the dat For inbound messages this is the date Sms4Domino Help C After some time the documents in the view are deleted by Sms4Domino 115 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 Notes clients version 7 or 8 must be used 116
77. on profile settings Most of the global parameters of the Sms4Domino software are specified in the application profile in the configuration database This document is mandatory and must be created by the database administrator You need manager level access to create such a profile You should close the Notes configuration database after any modification of the application profile It is required to stop and restart Sms4Domino in order to make the modifications to the application profile visible to Sms4Domino Procedure 1 Open the Sms4Domino configuration database 2 Select System gt Application Parameters in the navigator The profile document is opened in edit mode 3 Verify all default settings and modify them if necessary Default settings may be restored at any time by clicking the 7oo s action button More detail is provided in the following help pages 4 Click Save and Close to update the settings App cat on Pa ramet r File Edit View Create Actions Section Tools Window Help Openia Home x Sms4Domino x Application Parameters x lars lxa dea B E Close Save and Close Cancel Application Paran gt SMS4Domino Server settings gt Settings of SMSLib settings This is the protected text area of the form a 44 Sms4Domino Help Sms4Domino Server Settings This section contains global settings that are used by Sms4Domino Parameter Autostart server Delete mess
78. ooth link COM7 gt Standard Serial over Bluetooth link COM8 p Standard Serial over Bluetooth link COM9 mi Processors Connect the modem to the COM RS 232 port using a qualify RS 232 cable Launch the putty program Sms4Domino Help Sm Session Basic options for your PuTTY session gt Logging Specify the destination you want to connect to Serial line COM4 57600 Connection type Raw Telnet Rogn SSH Sejal Load save or delete a stored session Default Settings ATOPCOM1 ConiuGo DIGI Serial 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 B PuTTY Configuration be Category E Session Logging Terminal Keyboard Bell Features Window Appearance Behaviour Translation Selection Colours Connection Data Proxy Telnet Rlogin SSH Options controlling local serial lines Select a serial line Serial line to connect to Configure the serial line Speed baud Data bits Stop bits Parity Flow control COM4 57600 Qo 1 None None Cancel Withi
79. ore 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 Destinations restrictions Allowed destinations 32 0032 15 Comment Only local calls are allowed Only local calis are allowed Rejectec MHZ IS desinations 710 0 9 S Reject numbers gt 12 digits Reject numbers lt 10 digits Zero one or More regular expressions Every expression is entered on a separate line if none specified all destinations that are not blocked are allowed Only local cats Zero one or more regular expressions Every expression is entered on a separate line if none specified all destinations matched by the allowed destinations pattem are allowed Reject numbers gt 12 digts Reject numbers lt 10 digts 70 Sms4Domino Help Inbound SMS processing Sms4Domino presents all received Sms messages to every interface Each interface decides if the Sms can be received If none of the interfaces is capable of handling the inbound Sms the Sms is stored in the configuration database view Operations gt Received no match Sms4Domino mail interfaces may use two methods for matching inbound Sms messages to a Lotus Notes mail user e Fixed routing all Sms messages from a specified phone number should be routed to a fixed mail address This mail addr
80. ostics Advanced Driver Details Modem Information Field Value Hardware ID moto1_gen Command Response ATQOV1E0 Success AT GMM MC55i AT FCLASS 0 1 2 ATHCLS COMMAND NOT SUPPORTED Logging Append to Log View log OK Cancel e Prepare the modem for use with Sms4Domino e Decide on the architecture Sms4Domino may run as a Domino server add in started via RunJava or as a standalone program on a PC where Lotus Notes clients has been installed Sms4Domino Help Installation steps This document contains only a checklist of all installation steps More information is available in subsequent documents 1 2 10 11 Obtain a copy of the Sms4Domino template Sign the template with a proper user id Create a configuration database on a Domino server The database must always reside on a server not on a workstation Adjust the ACL settings Extract the dll and jar files from the configuration database and install them in the appropriate directories on the server or workstation where Sms4Domino will be running Add some mandatory parameters to the notes ini of the server or workstation where Sms4Domino will be running Define the basic parameters in the application profile of the configuration database Create and configure gateway documents Every transmission path to the GSM network requires a gateway document Create and configure interface documen
81. ould have read only access e A full text index is recommended on the help database e Incase separate databases are used for the accounting documents and or the foreign domain mailbox the procedure for creating the configuration database must be repeated The application profile in these databases contain a link to the main configuration database 39 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 The available roles and their purpose are explained in following table Role DBAdmin Recommended ACL settings for the server e Manager level access at least editor level access is required e All roles enabled Recommended ACL settings for administrators e Author level access e Delete documents Recommended ACL settings for the user id running Sms 4Domino When running Sms4Domino as a server add in this user id is the server id When running Sms4Domino as a standalone program this user id is the id specified by the notes ini entry KeyFileName This corresponds to the user id that was used the last time Lotus Notes was started e
82. owing example we would like DEBUG level logging to a file and INFO level logging to the console This is achieved by specifying the Threshold parameter for the least verbose appender log4j rootLlogger DEBUG console1 file1 log4j appender console1 Threshold INFO 85 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 In case your Domino environment consists of multiple Domino server you may need to configure Domino connection documents to specify the path from each server to the Sms4Domino server People amp Groups Files Server Messaging Replication Configuration pe j Release 8 5 2FP2 on Windows 2003 5 2 Intel Pentium aia e SA Hi m F 5ST mee Restrictions aes SEES TEREA eee Domain type Foreign Domain sE Foreign domain name SMS J Domain description Domain used by Sms4Domino 4 86 Sms4Domino Help Basics Restrictions Mail Information Calendar Information oy Gatewayservername syntrateacher anthos Gateway mail file name sms4domino db1 nsf F
83. port may prefix the number with the country code Sms4Domino requires an exact match between the outbound phone number and the one specified in the delivery report In order to be able to match the delivery report with the outbound Sms Sms4Domino must keep the outbound Sms long enough in the Domino configuration database This is defined by the setting Outbound SMS retention time on the mail interface document Outbound SMS retention time Test every n polling intervals No delivery report requested 160 minutes Delivery report requested 60 minutes 110 Sms4Domino Help Processing by the mail interface Mails delivered by the Domino router into the configuration database appear in the view Notes Mail Interface gt SMS box File Edit View Create Actions Tools Window Help Opena 1 A Home x Sms4Domino x IHF RSeiza eoeeern BACT Notes Mail Interface SMS box Operation 07 02 13 47 Wim Stevens Anthos John Doe 324i Reports System Sms4Domino Version 0 1 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 gt Operation 111 Sms4Domino Help File Create Actions Tools Window Help gan hh Home x Sms4Domino x 7 Seain
84. r SmsLib Inbound routes Interfaces Licenses Logging config Runtime files 1 document selected 7A Office Network e Click on the action button New Logging Configuration or double click on an existing Logging Configuration document Logging Configuration settings e Username this name is compared to the username running Sms4Domino Title just for documentation e 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 It is possible to change the logging parameters whilst the SMS4Domino server is running Use the command refresh logging to reload the logging config e Log4j properties log4j settings as they would appear in a log4j properties file Text starting with a character is considered being a comment The action button Set default for standard logging configures log4j for using a single console appender that outputs all INFO level events to the Sms4Domino console e Click Save and Close to save your changes 79 Sms4Domino Help topping Contgurion a eg Opens A He BFS elk2 5082 8939 2FSS seV Pe e DASE Logging Configuration Logging is based on the coen source Borary Lopd Configuration of the logging is pecioemed in Logging Configuration The same syntart as 3 Loo4 property fie is used Consult the heip fie for detas or use the Sefaut opa
85. r expressions e Validation of the result The resulting number should match a regular expression e Imposing restrictions on the resulting number This is implemented using whitelist or blacklist regular expressions 67 Sms4Domino Help E Interface MIF1 IBM Lotus Not oes File Edit View Create Actions Tet Tools Window Help Open g al Sms4 Domno Sms4Domer Sms4 Domno a g 3 K lo 5 D sJ B9399 Default Sans Serif Z FSSVGVeRt Se GAGE End users may specify a phone number in diferent formats Phone numbers must de rewritien into a standard intema onal format or into a stancard local number Standard international format consists of lt country code gt lt local number gt The phone number is processed in three steps Apply some standardisation filters Validate if the resulting number is a valid number Apply filters to reject SMS messages to certain destinations 9 sms to foreign county is not allowed ISO 3166 1 two letier country code Ris also used to automatically convert the supplied phone number into an ieernational format Example specify US for USA GB for United Kin BE tor Belgium Local country prefix i j The intematonai country prefix that most likely apply for people using Nis mail intertace Do not specify the The parameter is used by the wizards to compute the Dest phone number processing filters See wiki article for a complete list Example specify 0 for US 44 for UK or 32 for Belgium Imernaton
86. ry n polling intervals A value too high could result in too many old messages in sms box A value too low could overload the server o No delivery report requested even when no delivery reports is requested it could happen that a negative delivery report is received Negative value implies no 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 Pseudo sender mail address used as sender when Sms4Domino returns an email e g delivery report to a Notes user 65 Sms4Domino Help Bo M Lo O Incerts mF Ete gdt View Create Actions Section Tools Window Gar A ra go I8FR lt oeixoe82 B9S9 J JbsuBZ 2 AKPEEES EB ZF S SVVB DAE Requests tor sending SMS messapes are Created by sending an e mail to Domino mail routing routes tre mai to a foreign domain A Notes database 9 sms Dox Must De linked to Pe Goman The Notes mal message intertace reads he mails from the foreign domain maldor and Sends hem out as SMS messapes Name of he server Mlepam of he sms Dox Both empty server ang epath corresponds to the control database DAING used as sms Dox this version of Be program the control database must be used for sms Dor Empty server corresponds to Sms bor on he same server as the co
87. s list all known serial ports probe lt portname probe the given portname case sensitive at different speeds refresh logging refresh the logging settings from the config database het Status command Syntax status Purpose displays the status of Sns4Domino This status is also displayed in the gateway document see the help document about gateway documents 93 Sms4Domino Help 4 SMS4Domino sendi 20 19 51 990 Notes ini setting for SMS4DominoConfigDB sms4Domino db1 nst 20 19 51 996 SMSLib A Java API library for sending and receiving SMS via a GSM modem or other supported gateways is sofiware is distributed under the terms of the Apache v2 0 License eb Site hitp smslib org 20 19 51 997 Version 3 5 0 20 19 51 998 JRE Version 1 6 0 20 19 51 998 JRE Impl Version 2 4 20 19 51 999 O S Windows 7 x86 6 1 build 7601 Service Pack 1 20 19 52 124 Sms4Domino started as stand alone program 20 19 52 125 SMS4DOMINO a solution for sending SMS messages Consult hitp www sms4domino eu for more inf help ist of available commands help display this text start read the settings and start the server pause pause inbound and outbound polling resume resume a paused server quit shutdown of Sms4Domino status display the status of the sms server ports list all Known serial ports probe lt portname probe the given portname case sensitive at different speeds refresh logging
88. s mail messages users may send a SMS messages dy sending a mail to eg name s Test interface does not do any usefull work N does not send nor receive A hagher number means a higher prionty The highest priority interface is polled first for outbound SMS requests indDound SMS messages received trom the modem are presented first to the highest priority interface When two or more interfaces have the same priority they are potted in a non Geterminisie way interface Sow inbound Specty what kind of messages may de generated by delwvered to the interface E Inbound SMS message received from the GSM operator Status delivery report Qutbownd SUS message generated dy the interface Status Delivery Report notficatons received from the GSM operator as a feedback on 3 previous outbound message Only the Actve intertaces are used by Sms4Domino There should be at least one active interface For your intemal use 63 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 more SMS messages Requests for sending SMS messages are created by sending an e mail to lt name gt lt gsm number gt lt smsdomain gt or lt gsm number gt lt smsdomain gt Domino mail routing routes the mail to the foreign domain lt smsdomain gt A Notes datab
89. s may accept or reject the inbound delivery reports o Description is not used by Sms4Domino 60 Sms4Domino Help Ser o IBM Lotus No AFVxdID SsoSrxe SFSTVY HS Sone iDnenin Sms4Domino gt Notes Mail Interface gt g gt Reports Y System 1 document selected cA Ofc Network e Click on the action button New nterface 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 Select the kind of interface you would like to create Notes mail messages Test interface 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 General settings 61 Sms4Domino Help e Interface id Unique id of the interface All logging and accounting is based on this id e Interface description this free text field is only used by the administrator for documentation purposes e 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 o Notes mail messages end users send an email to a foreign Domino mail domain
90. s4Domino only supports a local or LAN connected modem We recommend using an industrial grade modem connected to a serial port not via USB bluetooth or infrared During testing we have noticed that not all modems are equal They may behave in unexpected ways under certain conditions In order to receive support for modem related questions you should use the Cinterion MC 55iT modem http www cinterion com In case the modem must be connected to the LAN we recommend the use of the ABLELink Ethernet Serial Server Atop technologies http www atop com tw Modern PCs have no are only one COM port It may be necessary to install an expansion board providing one two or more additional COM ports These cards come mostly with driver software After a successfull installation the COM ports must be visible in the Windows device manager Bi Device Manager nthe File Action View Help o9 nmlO la amp amp Network adapters a F Ports COM amp LPT Communications Port COM1 1 High Speed PCI Serial Port COM4 High Speed PCI Serial Port COMS p E Standard Serial over Bluetooth link COM10 3 Vd Standard Serial over Bluetooth link COM7 A Standard Serial over Bluetooth link COMB J Standard Serial over Bluetooth link COM9 After this verification it is possible to connect the modem to the COM port Read the documentation supplied with the modem You must know the communication speed and parameters betw
91. specified you may try using the generic modem If specified this pincode will be used to unlock the SIM card fA Office Network 54 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 Specific settings for IP Modem Gateway e Directions specify if the modem is used for sending SMS messages outbound and or receiving SMS messages inbound e P address the IP address of the serial to ethernet convertor It must be possible to ping this address from the machine where Sms4Domino will be running e P port the port number that has been configured in the serial to ethernet convertor When issuing a telnet command in binary mode to the lt ip address gt lt port gt number you should be able to send AT commands and receive the responses e Manufacturer model communication between the computer and the modem is based on AT commands Most modems are using the same set of AT commands Some modems deviate from the standard Specify Generic if your modem is not listed e PIN code the PIN code of the SIM card in the modem Sms4Domino may lo
92. 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 The fifth line specifies what information should be logged for each event In the example e d HH mm ss SSS time of the event in the format HH mm ss SSS e m the message supplied by the application e n new line character Procedure to create a Logging Configuration document e Open the Sms4Domino configuration database e Select System gt Logging config in the navigator The right part of the screen displays all defined logging configuration document o Only Active logging configuration documents are used by Sms4Domino o Sms4Domino will look for logging configuration documents that correspond to the user id that is running Sms4Domino Sms4Domino will build a log4j properties file that is the concatenation of all active logging configuration documents for the current Notes user o The title is just for documentation 78 Sms4Domino Help A Home Bl Sms4Domino Help Sms4Domino x Bl Sms4Domino Help are E ANT AAA a C a a a a Bee VQeGBare Sms4Domino Notes Mail Interface Operations Configuration Reports More detailed logging for the CommandLinelnterpreter class System More verbose logging i TRACE level logging for Notesmailinterface module Application Parameters i Additional logging for SmsServer Gateways Wim Stevens Anthos Trace level logging fo
93. st the software without having to pay the phone company The gateway simulates sending and receipt of sms messages o Stub gateway inbound gateway that never receives any messages This kind of gateway is only used for internal purposes There is no practical reason for you to create a stub gateway e Gateway availability only Active gateways are used by Sms4Domino In case of hardware problems you could disable a gateway Remember to restart Sms4Domino after a parameter change e Gateway status when Sms4Domino is started the program will update the active gateway documents each time the status changes The gateway status is managed by SmsLib and reported to Sms4Domino Possible status values are STARTING STARTED FAILURE RESTART STOPPING O O O O 90 51 Sms4Domino Help o STOPPED e Comment free text field EFS Ole OBY BS O etour sens set SFVeS vee Re F eg Gateway docements how SMS messages are fed into or received from De GSM network The current version of Sms4Domino does not receive SMS messages AR gateway defiridons are read into memory when SmsaDomino is taunched When Modifying a setting a restart of he Sms4Domino server is required Gateway ic Unique td of ie gateway All logging and accounting is based on Pis id Oniy used for Gocumentation Oescrides how Sms4Dormune interfaces to he GSM network In this version oniy following gateway famites are supported Serial modem gateway modem recommenced or GSM phon
94. 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 To verify the current setting of AT Q simply check the settings of the active profile with AT amp V 22 Sms4Domino Help i ov BB COMA PuTTY i lo So Later when configuring the Sms4Domino environment and gateways you should define the same parameter settings Save the settings to non volatile RAM The AT amp 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 23 Sms4Domino Help f ER COM4 PuTTY 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 This may be for example the SIM PIN1 to register to the GSM network or the SIM PUK1 to replace a disabled SIM PIN1 with a new one or the PH SIM PIN if the client has taken precautions for preventing damage in
95. the event of loss or theft etc If requested by the ME AT CPIN may also be used for the SIM PIN2 or SIM PUK2 If no PIN1 request is pending for example if PIN1 authentication has been done and the same PIN1 is entered again MC52i responds CME ERROR operation not allowed no further action is required Each time a password is entered with AT CPIN the module starts reading data from the SIM The duration of reading varies with the SIM card This may cause a delay of several seconds before all commands which need access to SIM data are effective We could further verify that the modem has been properly registered to the GSM network Enter the AT COPS command 24 Sms4Domino Help Appendix Cinterion AT command guide mc52i_atcommands_v01201a pdf D5 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 Following steps must be executed e Connect the serial server to the LAN e Assign a fixed IP address to the serial server e Configure the serial server e Save the settings e Test the setup via a Telnet connection Connect the serial server
96. the only acceptable setting for this release o Leaving the server name empty corresponds to sms box on the same server as the 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 However this template must contain a specific set of views see next o Sms4Domino program must have editor level access or higher to the database and the right to delete documents e New mail viewname the Notes Mail interface scans at regular intervals this view for mails that must be transmitted as SMS The view must have the same layout as the view Mail in the Sms4Domino template The view is processed from top to bottom e Sms By Uuid viewname SMS server tracks the sending of sms messages in response documents linked to the received mail The response messages are created in the sms box database Every outbound SMS message is identified by a UUID This view lists all outbound mails sorted by UUID The design of the view must be based on the vwSMS_ByUuid view as defined in the Sms4Domino template e Sms By Refnr PhoneNr viewname Message delivery confirmations and failures must be matched to a past outbound SMS message The match is based on the Reference Number received from the SMSC concat
97. things as field width padding left and right justification The following is a simple example copied from the log 4j Javadoc http ogging apache org log4j 1 2 apidocs org apache log4j PatternLayout html Let the conversion pattern be 5p t m n and assume that the log4j environment was set to use a PatternLayout When logging the messages Message 1 and Message 2 would yield the output DEBUG main Message 1 WARN main Message 2 Some conversion characters e c name of the logger e d date of the logging event It may be followed by a date format written between E g d HH mm ss SSS or d dd MMM yyyy HH mm ss SSS If no date format specifier is given then ISO8601 format is assumed e m the application supplied message associated with the logging event e _n the platform dependent line separator character or characters e the sequence outputs a single percent sign 81 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 og4j rootLogger NFO console 7 log4j appender console1 org apache log4j ConsoleAppender log4j appender console1 layout org apache log4j Patter
98. to start Sms4Domino supports different gateway types called Gateway Family serial modems IP modems Internet SMS service providers Gateways may be outbound sending SMS messages from Domino to the rest of the world or inbound receiving SMS messages from anywhere in the world The settings in the Gateway documents are read into memory when Sms4Domino starts If you need to make changes to any of the settings you will have to quit and start the Sms4Domino application Procedure to create a Gateway document e Open the Sms4Domino configuration database e Select System gt Gateways in the navigator The right part of the screen displays all defined gateways o Only Enabled gateways are used by Sms4Domino o Gateway ID must be unique All gateway related logging uses this id o Family o The status of the enabled modems is updated in real time by Sms4Domino This info is not valid when Sms4Domino is not running You may need to refresh the view by clicking F9 o Description is not used by Sms4Domino Sm Domino IBM Lo or file Edit View Create Actions Tools Window Help Open T b A Home BB Sms400n p Sms4Domino x AFZoiI2V FsoxseeeBaAes SLFVFVWYE Be SeGAGEG New Gateway Enabled Gateway ID Farnity Status Status Date Operabons J CINTERION Serial modem gateway STOPPED 2103201207 19 ATOP IP modem gateway Notes Mail Interface Reports CINTERION_LAN IP modem gateway System DIGI IP modem gateway App cabon Param
99. ts Each source of SMS requests requires an interface document Domino mail interfaces may receive the Domino mails in the configuration database or in a separate database In all cases it is the most practical to base the databases on the Sms4Domino template Create and configure a license document Obtain a valid license file from Sms4Domino and copy the contents of the file into the license document Create and configure logging documents Logging is based on the Apache log4J software Logging may be very tearse of verbose Output of the logging may be directed to the Domino log nsf or to a Windows file Define a foreign domain in the Domino directory Notes users will address mails to John 3618319 sms or to 3618319 sms for sending a SMS message to this number De mailbox of the foreign domain points to the Sms4Domino control database or another database that has been defined in the interface document Start the Sms4Domino program The system is now ready to be used The administrator should Monitor the system Perform maintenance actions Sms4Domino Help Choice and installation of the modem 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 Sm
100. utes Default value 1 440 minutes Conflict period 1400 minutes A conflict situation occurs when John and Paul send an SMS to Jane When Jane replies Sms4Domino has no idea who should get the reply Sms4Domino deleted the Inbound Routing documents that are older than the conflict period Avalue lt 0 suppresses the deletion of indound routing documents Default value 2 880 minutes Cleanup every n 10 Auto matching routing documents may be deleted when the conflict period polling intervals every 200 seconds has been passed This clean up is performed within the main polling cycle of the mail interface This Cleanup is performed every N polling cycles Avalue lt 0 suppresses the cleanup of inbound routing documents Default value 20 71 Sms4Domino Help Server license settings All license settings are found via System gt Licenses Sms4Domino looks at regular intervals for the presence of a valid license 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 server deployments The validity of a license may depend on multiple factors Typical elements are e Servername where the configuration database is stored e User id that runs Sms4Domino e Number of active inbound or outbound gateways defined by the configuration database e Expiration date of the license The current dat
101. ve The value is in seconds Default 60 s This is the buffer size SMSLib uses for the internal queues The value represents characters bytes Default 16 384 bytes This is a delay value used when clearing the queues The value is in milliseconds Default 1 000 ms If set RTS CTS will be enabled for outbound serial traffic as well Useful for some types of phones 47 Sms4Domino Help QUEUE_RETRIES AT_WAIT AT_WAIT_AFTER_RES ET AT_WAIT_CMD AT_WAIT_CGMS AT_WAIT_NETWORK AT_WAIT_SIMPIN CNMI_EMULATOR_INTER VAL OUTBOUND_RETRIES OUTBOUND_RETRY_WAI T WATCHDOG_INTERVAL MASK_IMSI CONCURRENT_GATEWA Default false 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 This is a delay value used after some AT commands The value is in milliseconds Default 200 ms This is the delay value SMSLib will sleep for this period after issuing a modem reset command in order to give time to the modem to initialize The value is in milliseconds Default 10 000 ms This is a delay value representing the time needed after issuing a command The value is in milliseconds Default 1 100 ms This is a delay value representing the time needed after issuing a CMGS command The value is in milliseconds Default 200 ms This is a delay value representing

Sms4Domino - Help V1.0

Contents

Download Pdf Manuals

Related Search

Related Contents