Natively Connect to Cvent Data in PHP via ODBC (Linux)

Drop the CData ODBC Driver for Cvent into your LAMP or WAMP stack to build Cvent-connected Web applications. This article shows how to use PHP's ODBC built-in functions to connect to Cvent data, execute queries, and output the results.

Using the CData ODBC Drivers on a UNIX/Linux Machine

The CData ODBC Drivers are supported in various Red Hat-based and Debian-based systems, including Ubuntu, Debian, RHEL, CentOS, and Fedora. There are also several libraries and packages that are required, many of which may be installed by default, depending on your system. For more information on the supported versions of Linux operating systems and the required libraries, please refer to the "Getting Started" section in the help documentation (installed and found online).

Installing the Driver Manager

Before installing the driver, check that your system has a driver manager. For this article, you will use unixODBC, a free and open source ODBC Driver manager that is widely supported.

For Debian-based systems like Ubuntu, you can install unixODBC with the APT package manager:

$ sudo apt-get install unixodbc unixodbc-dev

For systems based on Red Hat Linux, you can install unixODBC with yum or dnf:

$ sudo yum install unixODBC unixODBC-devel

The unixODBC driver manager reads information about drivers from an odbcinst.ini file and about data sources from an odbc.ini file. You can determine the location of the configuration files on your system by entering the following command into a terminal:

$ odbcinst -j

The output of the command will display the locations of the configuration files for ODBC data sources and registered ODBC drivers. User data sources can only be accessed by the user account whose home folder the odbc.ini is located in. System data sources can be accessed by all users. Below is an example of the output of this command:

DRIVERS............: /etc/odbcinst.ini
SYSTEM DATA SOURCES: /etc/odbc.ini
FILE DATA SOURCES..: /etc/ODBCDataSources
USER DATA SOURCES..: /home/myuser/.odbc.ini
SQLULEN Size.......: 8
SQLLEN Size........: 8
SQLSETPOSIROW Size.: 8

Installing the Driver

You can download the driver in standard package formats: the Debian .deb package format or the .rpm file format. Once you have downloaded the file, you can install the driver from the terminal.

The driver installer registers the driver with unixODBC and creates a system DSN, which can be used later in any tools or applications that support ODBC connectivity.

For Debian-based systems like Ubuntu, run the following command with sudo or as root:

$ dpkg -i /path/to/package.deb

For Red Hat systems or other systems that support .rpms, run the following command with sudo or as root:

$ rpm -i /path/to/package.rpm

Once the driver is installed, you can list the registered drivers and defined data sources using the unixODBC driver manager:

List the Registered Driver(s)

$ odbcinst -q -d
CData ODBC Driver for Cvent
...

List the Defined Data Source(s)

$ odbcinst -q -s
CData Cvent Source
...

To use the CData ODBC Driver for Cvent with unixODBC, ensure that the driver is configured to use UTF-16. To do so, edit the INI file for the driver (cdata.odbc.cvent.ini), which can be found in the lib folder in the installation location (typically /opt/cdata/cdata-odbc-driver-for-cvent), as follows:

cdata.odbc.cvent.ini

...

[Driver]
DriverManagerEncoding = UTF-16

Modifying the DSN

The driver installation predefines a system DSN. You can modify the DSN by editing the system data sources file (/etc/odbc.ini) and defining the required connection properties. Additionally, you can create user-specific DSNs that will not require root access to modify in $HOME/.odbc.ini.

Before you can authenticate to Cvent, you must create a workspace and an OAuth application.

Creating a Workspace

To create a workspace:

1. Sign into Cvent and navigate to App Switcher (the blue button in the upper right corner of the page) >> Admin.
2. In the Admin menu, navigate to Integrations >> REST API.
3. A new tab launches for Developer Management. Click on Manage API Access in the new tab.
4. Create a Workspace and name it. Select the scopes you would like your developers to have access to. Scopes control what data domains the developer can access.
   • Choose All to allow developers to choose any scope, and any future scopes added to the REST API.
   • Choose Custom to limit the scopes developers can choose for their OAuth apps to selected scopes. To access all tables exposed by the driver, you need to set the following scopes:

     event/attendees:read	event/attendees:write	event/contacts:read
     event/contacts:write	event/custom-fields:read	event/custom-fields:write
     event/events:read	event/events:write	event/sessions:delete
     event/sessions:read	event/sessions:write	event/speakers:delete
     event/speakers:read	event/speakers:write	budget/budget-items:read
     budget/budget-items:write	exhibitor/exhibitors:read	exhibitor/exhibitors:write
     survey/surveys:read	survey/surveys:write

Creating an OAuth Application

After you have set up a Workspace and invited them, developers can sign up and create a custom OAuth app. See the Creating a Custom OAuth Application section in the Help documentation for more information.

Connecting to Cvent

After creating an OAuth application, set the following connection properties to connect to Cvent:

• InitiateOAuth: GETANDREFRESH. Used to automatically get and refresh the OAuthAccessToken.
• OAuthClientId: The Client ID associated with the OAuth application. You can find this on the Applications page in the Cvent Developer Portal.
• OAuthClientSecret: The Client secret associated with the OAuth application. You can find this on the Applications page in the Cvent Developer Portal.

/etc/odbc.ini or $HOME/.odbc.ini

[CData Cvent Source]
Driver = CData ODBC Driver for Cvent
Description = My Description
OAuthClientId = MyOAuthClientId
OAuthClientSecret = MyOAuthClientSecret
InitiateOAuth = GETANDREFRESH

For specific information on using these configuration files, please refer to the help documentation (installed and found online).

Establish a Connection

Open the connection to Cvent by calling the odbc_connect or odbc_pconnect methods. To close connections, use odbc_close or odbc_close_all.

$conn = odbc_connect("CData ODBC Cvent Source","user","password");

Connections opened with odbc_connect are closed when the script ends. Connections opened with the odbc_pconnect method are still open after the script ends. This enables other scripts to share that connection when they connect with the same credentials. By sharing connections among your scripts, you can save system resources and queries execute faster.

$conn = odbc_pconnect("CData ODBC Cvent Source","user","password");
...
odbc_close($conn); //persistent connection must be closed explicitly

Create Prepared Statements

Create prepared statements and parameterized queries with the odbc_prepare function.

$query = odbc_prepare($conn, "SELECT * FROM Events WHERE Virtual = ?");

Execute Queries

Execute prepared statements with odbc_execute.

$conn = odbc_connect("CData ODBC Cvent Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM Events WHERE Virtual = ?");
$success = odbc_execute($query, array('true'));
 

Execute nonparameterized queries with odbc_exec.

$conn = odbc_connect("CData ODBC Cvent Source","user","password");
$query = odbc_exec($conn, "SELECT Id, Title FROM Events WHERE Virtual = 'true'");
 

Process Results

Access a row in the result set as an array with the odbc_fetch_array function.

$conn = odbc_connect("CData ODBC Cvent data Source","user","password");
$query = odbc_exec($conn, "SELECT Id, Title FROM Events WHERE Virtual = 'true'");
while($row = odbc_fetch_array($query)){
 echo $row["Id"] . "\n";
}

Display the result set in an HTML table with the odbc_result_all function.

$conn = odbc_connect("CData ODBC Cvent data Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM Events WHERE Virtual = ?");
$success = odbc_execute($query, array('true'));
if($success)
 odbc_result_all($query);

More Example Queries

You will find complete information on the SQL queries supported by the driver in the help documentation. The code examples above are Cvent-specific adaptations of the PHP community documentation for all ODBC functions.