SMS Dispatch Manager
|Table of contents|
On the « Global Setting » tab of the SMS Dispatch Manager Setup window it is possible to configure the following functional options:
A view of the « Global Settings » settings window
The following parameters control how the queue is managed. The SMS Dispatch Manager program manages a processing queue (the file /bin/sms_queue/MsgQueue.xml) which it checks at regular intervals.
At each queue processing interval, several actions are performed in the following order:
The SMS to be sent should have been submitted beforehand by either LoriotPro or any other program into the /bin/sms_queue directory and should respect the following format: « 1244537694_sms.xml ». The value placed at the beginning (timestamp), corresponds to the date and time that the SMS was created by LoriotPro or a third party application.
The contents of the file should respect the following format:
Message Queue Processing Interval
This parameter makes it possible to define the frequency for processing the queue.
The polling interval for the queue should not be too short. Sending SMS messages takes time due to the fact that communication between the module and the modem which is made via a serial link is slow and so is access to the operator’s network. We strongly recommend a « Message Queue Processing Interval » of at least 30 seconds minimum or more ideally, 1 minute.
Message creation date validity window
The « Message creation date validity window » makes it possible to define the maximum age of a message that is still valid for sending (file xxxxxxxx_sms.xml deposited in the/bin/sms_queue directory).
This value, expressed in minutes is the maximum acceptable time that has passed between the time that the file was created in the directory, and the time of the reading of this file in the processing queue of SMS Dispatch Manager.
A value of 1 minute is incorrect. A value between 5 and 30 minutes is more reasonable. We also consider that the sending of these messages carries a sense of urgency and that if for any reason the messages cannot be sent rapidly, their dispatch becomes rather worthless. In addition, in case of an interruption to the SMS Dispatch Manager program, this security measure also prevents SMS messages that have become obsolete because they are too old, from being sent when the program is restarted.
Send Retry Count
In case of a failure to send an SMS due to a faulty modem or an unavailable network, successive attempts to re-send will be carried out. This parameter makes it possible to define the number of attempts to be made before completely abandoning the dispatch.
Phone Number length verification (0-disable verification)
It is possible to activate a procedure for verifying the telephone number from which acknowledgement or action messages were received. Verification is carried out on the x last digits of the number, to be determined by the value defined in this parameter.
This verification ensures that the acknowledgement or action SMS have really been sent by people declared in the internal list of SMS Dispatch Manager.
The verification is not carried out on all of the digits of the phone number due to the fact that the internal format of the number may be different from that of the number sent by the operator.
For example, in France, the number of a person declared as a « recipient » in SMS Dispatch Manager could be listed as 0645123875, while the value of the number sent by the operator of the GSM network is displayed as +33645123875.
We recommend that you carry out verification on the last 8 digits of the number (default value) but this should be adjusted in relation to the operator.
A 0 value indicates that no verification shall be carried out on the incoming number.
Message History parameters
All messages and actions processed by the program are saved in the history files at regular intervals or manually.
The history files are created for an entire day.
History Creation Time
This parameter determines the hour for generating a history file.
Aging Time for message Deletion
This parameter determines the maximum length of time a message can be kept before it is deleted from the message queue.
The value defined in this field should be deducted from the time of generating the historical report in order to determine the invalidity value. Messages placed in the queue at a time superior to this invalidity value, will be deleted and placed in the history file.
The history file can be generated immediately by just clicking on the « Create History » button.
The queue can be cleared by clicking on the « Clean Queue» button. All SMS messages whose «Aging time » has been surpassed will be deleted.
The License Information field displays information relating to the actual license linked to the program.
The SMS Dispatch Manager program should have either an Evaluation License or a valid definitive Licence in order to function. If this is not the case, a window indicating that your license has expired will be displayed.
Note: If you get this Popup on the screen and you wish to cancel its apparition and you do not have a valid licence, you will need to delete the SMS Dispatch Manager plug-in from the services list available on the Services Tab of LoriotPro.
The license consists of a simple text file SMSLicence.ini, present in the /bin directory.
The «Send Event on Start », « Send Event on Stop », or « Send Event on Error » options, activate the process for generating events in LoriotPro.
Send Event on Start: Each time that the SMS Dispatch Manager program is launched by clicking on the « Start » button, an « Event » with the number 420 is sent.
Send Event on Stop: Each time that the SMS Dispatch Manager program is stopped by clicking on the « Stop » button, an « Event » with the number 421 is sent.
Send Event on Error: Each time there is an error in the SMS Dispatch Manager program linked to a failure to send SMS messages, an « Event » with the number 422 is sent.
For diagnostic purposes, it is possible to create a log journal for debugging the module. This journal will be used by LUTEUS’s developers to analyse the behaviours of the program.
To activate the collection of logs, you must select the Enable Logging box.
To display the logs, click on the View Log button.
Example of a log
The log files are saved in the /bin/sms_queue/PluginLogFile directory on the basis of 1 file per day.