FILE PLUGIN INSTALLATION AND CONFIGURATION

Ozeki Message Server empowers you to send and receive SMS from a personal computer through a GSM device attached to the computer or using an IP SMS connection. The sending task could be performed by placing txt files into a certain directory. Receiving can be done by reading txt files from another directory in the file system.

PLUGIN INSTALLATION

In the following section, we will show the easy process of the plugin installation.

New plugins can be installed by choosing Installed Plugins from the Plugin menu of the Ozeki Message Server.

available plugins for installation
Figure 1 -

In the "Available plugins for installation" window click on the File plugin install link and the installation process will start.

starting the configuartion
Figure 2 - Starting the configuration

After installation you'll see the File plugin 1 appearing on the list of plugins in the "Currently installed plugins" screen. On this form you can start the configuration by clicking on the Configure link. (Figure 4.)

PLUGIN CONFIGURATION

To start the configuration, click on the Configure URL and specify the path of the directory. If you want to send and receive SMS this way, you should configure the OZEKI SMS Server to place the incoming messages into the selected directory and to check another directory periodically for messages to send. The directory we use for receiving messages is called the incoming directory, the one we use for sending messages is called the outgoing directory.

If you would like the File plugin to start automatically when the Ozeki Message Server software starts, place a checkmark into the "Autoconnect on startup" checkbox and press Ok. (Figure 5.)

automatic startup directories
Figure 3 - Automatic startup directories

When the directory settings are configured, an appropriate txt file format should be selected. The OZEKI SMS Server supports four kinds of file formats. You should select the one that fits your needs the most.

The four supported formats are: simple, verbouse, list and XML.

file format
Figure 4 - File format

THE SIMPLE FILE FORMAT

When you select the simple file format, each incoming message is saved in a separate file. The name of the file is the phone number and the first row of the file contains the message. (Figure 7.)

c:\smsout\+36203105366 

Hello world

Figure 5 - Simple file format

If you want to send messages using the simple file format, you should create a separate textfile for each outgoing message and place these files into the smsout directory.

THE VERBOUSE FILE FORMAT

The verbouse file format is similar to the simple file format in a way that each message resides in a seperate file. The difference is that it contains more detailed information about the SMS messages. The main advantage of this file format is that more than one message could be placed into the same directory with the same destination.

If you want to send messages using this format, make sure that the extension of the file name that is placed into the outgoing directory is .sms and the file format is the following:

The first row of the file is the sender's phone number, the second row contains receiver phone number and the message text follows these in the next row. Take a look at the example:

c:\smsout\anyname.sms 

+36203105366
+36209937723
The message text

Figure 6 - Verbouse file format

THE LIST FILE FORMAT

The list file format is a convenient way to send and receive a large number of sms messages. In this case more than one message is stored in the same file. The format of the file can be seen below.

For outgoing messages you should create a text file, where each line contains a message. The messages consist of a phone number in international format and the message text. The phone number and the message text is separated by a space character.

When an outgoing file is ready to be sent it should be placed into the smsout directory. The name of the file should have the .sml extension. (sml stands for sms list)

c:\smsout\list.sml 

+36205555366 This is the first message
+36209937723 This is the second message
+36307789723 Use the OZEKI SMS Server!

STARTING THE PLUGIN

After the plugin has been installed, you need to start it. You can start the Ozeki Message Server File plugin by clicking on "Connect" in the "Currently installed plugins" screen (Figure 9., Figure 10.).

starting the plugin
Figure 7 - Starting the plugin

After you have clicked on the Connect URL, you may use the Refresh this page link to check the connection state.

checking the plugin connection state
Figure 8 - Checking the plugin connection state

If the connection was successfull the Connection state will be changed from offline to online. The connection picture also shows the online state.

Please read more about this in the file plugin section in the developers guide.

More information