How to setup Database Logger

Using Database Logger you can log PBX events into your database to archive all PBX events for a long period and to make it easy to work with the information provided by the PBX. In this guide you will see how to install, then how to configure Database Logger SQL API in Ozeki Phone System XE.

Step 1: How to install Database Logger SQL API
Step 2: How to configure Database Logger SQL API
Step 3: Table structure
Step 4: Create table scripts

Step 1: How to install Database Logger SQL API

First of all, open Ozeki Phone System XE, in a web browser, and login with your username and password (Figure 1).

Figure 1 - Login page

On the main page of Ozeki Phone System XE, select Productivity from the upper menu bar and then select SQL API (Figure 2).

Figure 2 - Main page

On the following page, click on Install button (Figure 3).

Figure 3 - SQL API page

On the next page, click on the Install button right next to the Database logger SQL API (Figure 4).

Figure 4 - Install Database logger

Step 2: How to configure Database Logger SQL API

In this step you will see how to configure Database logger SQL API.

Under the Database Connection tab you should to setup the following options.

First you need to enter the Connection name which will be the name of the extension by default. Next choose the Data source. If you select the MSSQL or the MySQL you don't need to install any other plugin or connector to your system, the Ozeki Phone System XE can handle these databases easily. But if you choose Odbc or OleDb you need to install connector for them to access database management systems.

At the Configuration mode section you can choose between Simple or Advanced configuration mode. The Simple configuration mode can only be used when you connect Ozeki Phone System XE to MSSQL or MySQL data sources. (If you selected Odbc or OleDb data sources you can reach only the Advanced configuration mode.) The Simple mode is intended to make the configuration easier for these connection types. If you select this option you need to add four informations:

• the Server is the IP address or URL of the database server.
• the Database name is the name of the databse to use by the system.
• the Username is for access the selected database.
• the Password.

Figure 5 - Database Connection Simple options

But if you would like to add more informations and parameters to connect to the database, choose the Advanced configuration mode and you can change the Connection string which is a description of a database connection regarding the selected data source type. You can find different connection strings related to a lot of database servers here.

Figure 6 - Database Connection Advanced options

On the configuration form of the Database logger API, under the SQL templates tab, you need to provide the SQL queries that will store the main changes of the database server. The followings will be inserted into the database:

• Time: The time when the log entry was created.
• Level: The level of the log (INFO, DEBUG, ERROR or WARNING).
• Code: The id of the log event.
• Logger: The module of the PBX in which the event occured.
• Message: The message of the event.

Figure 7 - SQL templates of Database logger

Step 3: Table structure

After the Database Logger SQL API has been configured in the Ozeki Phone System XE, you need to create the database tables for Database Logging SQL API. Use the following table layout:

• ozpbxlog table

Step 4: Create table scripts

Microsoft SQL Server

CREATE  TABLE ozpbxlog
(
    id int identity(1,1) PRIMARY KEY,
    Time datetime NOT NULL,
    Thread int NOT NULL,
    Level varchar(20) NOT NULL,
    Code varchar(20) NOT NULL,
    Logger varchar(255) NOT NULL,
    Message text NOT NULL,
)

Microsoft SQL Express

CREATE  TABLE ozpbxlog
(
    id int identity(1,1) PRIMARY KEY,
    Time datetime NOT NULL,
    Thread int NOT NULL,
    Level varchar(20) NOT NULL,
    Code varchar(20) NOT NULL,
    Logger varchar(255) NOT NULL,
    Message text NOT NULL,
)

Oracle

CREATE TABLE ozpbxlog
(
    id integer PRIMARY KEY,
    Time timestamp NOT NULL,
    Thread integer NOT NULL,
    Level varchar(20) NOT NULL,
    Code varchar(20) NOT NULL,
    Logger varchar(255) NOT NULL,
    Message nclob NOT NULL,
)

CREATE SEQUENCE id_seq START WITH 1 INCREMENT BY 1;

CREATE OR REPLACE ozpbxlog_insert
BEFORE INSERT ON ozpbxlog
FOR EACH ROW
BEGIN
    SELECT id_seq.nextval INTO :new.id FROM dual;
END;
/

MySQL

CREATE  TABLE IF NOT EXISTS `ozpbxlog` (
    `id` int(11) AUTO_INCREMENT,
    `Time` datetime NOT NULL,
    `Thread` int(11) NOT NULL,
    `Level` varchar(20) NOT NULL,
    `Code` varchar(20) NOT NULL,
    `Logger` varchar(255) NOT NULL,
    `Message` text NOT NULL,
    PRIMARY KEY (`id`))
ENGINE = InnoDB
DEFAULT CHARACTER SET = utf8; 

PostgreSQL

CREATE TABLE ozpbxlog
(
    id serial PRIMARY KEY, 
    Time date NOT NULL,
    Thread integer NOT NULL,
    Level varchar(20) NOT NULL,
    Code varchar(20) NOT NULL,
    Logger varchar(255) NOT NULL,
    Message text NOT NULL
)

Sybase (SQL Anywhere)

CREATE TABLE ozpbxlog (
  id integer NOT NULL DEFAULT autoincrement,
  Time datetime NOT NULL,
  Thread integer NOT NULL,
  Level varchar(20) NOT NULL,
  Code varchar(20) NOT NULL,
  Logger varchar(255) NOT NULL,
  Message text NOT NULL,
  PRIMARY KEY ("id")
)

go 
commit work 
go

DB2

CREATE TABLE ozpbxlog (
   (id integer NOT NULL GENERATED ALWAYS AS 
       IDENTITY (START WITH 1 INCREMENT BY 1),
    Time          TIMESTAMP    NOT NULL,
    Thread        INTEGER      NOT NULL,
    Level      VARCHAR(20)  NOT NULL,
    Code      VARCHAR(20)  NOT NULL,
    Logger        VARCHAR(255) NOT NULL,
    Message       CLOB         NOT NULL,
    PRIMARY KEY (id))

Informix

CREATE TABLE ozpbxlog
(
	id serial PRIMARY KEY, 
	Time datetime NOT NULL,
	Thread int NOT NULL,
	Level varchar(20) NOT NULL,
	Code varchar(20) NOT NULL,
	Logger varchar(255) NOT NULL,
	Message text NOT NULL
)

FoxPro

CREATE TABLE ozpbxlog
   (id I AUTOINC NEXTVALUE 1 STEP 1 PRIMARY KEY, 
    Time T NOT NULL,
    Thread I NOT NULL,
    Level C(20) NOT NULL,
    Code C(20) NOT NULL,
    Logger C(255) NOT NULL,
    Message N NOT NULL)

If you have any questions or need assistance, please contact us at info@ozekiphone.com.

Dig deeper!
People who read this also read...

• How to make calls using your database server
• How to send and receive SMS messages using your database server
• How to connect your VoIP phone to Ozeki PBX using your database server