How to setup Database authenticator

For automating telephone access management in your IT system, the Ozeki Phone System XE provides an outstanding opportunity to connect VoIP phones to your PBX without adding any new SIP extension on the GUI of your phone system. Database Authenticator SQL API enables to create SIP accounts and authenticate extensions by simply keeping your database up to date. In this guide you will see how to install and configure Database authenticator SQL API in Ozeki Phone System XE.

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

Step 1: How to install Database authenticator 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 authenticator SQL API (Figure 4).

Figure 4 - Install Database authenticator

Step 2: How to configure Database authenticator SQL API

In this step you will see how to configure Database authenticator 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

Database Authenticator has an SQL Templates tab. The following figure shows the SQL queries makes it possible to verify if a SIP account is available or not in your database. The following values will be selected from the database:

• username: The phone number of the SIP extension.
• authname: The authorization name is used for authentication purposes.
• password: The password is also used for authentication.

Figure 7 - SQL templates of Database authenticator

Step 3: Table structure

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

• ozpbxusers table

Step 4: Create table scripts

Microsoft SQL Server

-- -----------------------------------------------------
-- Table `OzekiPBX`.`ozpbxusers`
-- -----------------------------------------------------
CREATE TABLE ozpbxusers
(
    authname varchar(45) PRIMARY KEY,
    username varchar(45) NOT NULL,
    password varchar(45) NOT NULL,
)

Microsoft SQL Express

CREATE TABLE ozpbxusers
(
    authname varchar(45) PRIMARY KEY,
    username varchar(45) NOT NULL,
    password varchar(45) NOT NULL,
)

Oracle

CREATE TABLE ozpbxusers
(
    authname varchar(45) PRIMARY KEY,
    username varchar(45) NOT NULL,
    password varchar(45) NOT NULL,
)

MySQL

CREATE  TABLE IF NOT EXISTS `ozpbxusers` (
    `authname` varchar(45) NOT NULL,
    `username` varchar(45) NOT NULL,
    `password` varchar(45) NOT NULL,
    PRIMARY KEY (`authname`),
    UNIQUE INDEX `username_UNIQUE` (`username` ASC))
ENGINE = InnoDB
DEFAULT CHARACTER SET = utf8;

PostgreSQL

CREATE TABLE ozpbxusers
(
    authname varchar(45) PRIMARY KEY,
    username varchar(45) NOT NULL,
    password varchar(45) NOT NULL
}

Sybase (SQL Anywhere)

CREATE TABLE ozpbxusers (
  authname char(45) NOT NULL,
  username char(45) NOT NULL,
  password char(45) NOT NULL,
  PRIMARY KEY (authname)
}

DB2

CREATE TABLE ozpbxusers
   (authname varchar(45) NOT NULL,
    username varchar(45) NOT NULL,
    password varchar(45) NOT NULL,
    PRIMARY KEY (authname)}

Informix

CREATE TABLE ozpbxusers
(
  authname char(45) PRIMARY KEY,
  username char(45) NOT NULL,
  password char(45) NOT NULL
}

FoxPro

CREATE TABLE ozpbxusers
   (authname C(45) PRIMARY KEY,
    username C(45) NOT NULL,
    password C(45) 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 log PBX events in your database