How to create a "Users and applications" module
In this guide you can find information on how to get started if you
wish to create a module to be used internally in Ozeki NG SMS Gateway.
There are several advantages to such a module. The biggest one is performance.
An internal module that does the processing is the fastest way to process
messages.
Introduction
To create a module you need to have Visual Studio 2005 (or newer version),
and you must be able to understand code written in C#. To create the module
you can use C#, Visual Basic, or any other .NET language. (The example is
written in c#). You also need an installed copy of Ozeki NG SMS Gateway
on your system. You can use the trial version for development.
How to get started
To create a module you need to implement the interfaces of ozApplicationAPI.
This API is used by Ozeki NG SMS Gateway to communicate with the "users and
applications" entities. This API has events and it offers procedures to call,
that allow you to register your
module in Ozeki NG and to interact with Ozeki NG. It also allows you to use the
"Windows Form to HTML conversion functionality" offered by Ozeki NG. You can use
this functionality to add a configuration form to your module.
The best way to start is to take a look at the example application provided.
The example application (ozAppVoting solution, that can be found in the
OzekiAPI.zip file) is
a simple implementation of the ozApplicationAPI interface. It receives incoming
messages and generates responses based on values configured by the user.
Information for compiling and debugging
During the development you will build on your own dll. To debug your dll, you
must
copy it to the root directory of Ozeki NG SMS Gateway. The root directory is:
C:\Program Files\Ozeki\OzekiNG - SMS Gateway. After the dll is placed into the
OzekiNG root directory you should start Ozeki NG in application mode. You can
use this by running the OzekiNG.exe file with the /run parameter.
Before you run OzekiNG.exe in application mode, you need to stop the OzekiNG
service. This can be done in the Windows Control panel.
If you use the ozAppVoting.sln solution, the ozAppVoting project properties are
already configured to place the compiled dll into the correct location and to
launch OzekiNG.exe in application mode for debugging.
|