Ready to get started?

Learn more or sign up for a free trial:

CData Connect Server

Access HCL Domino Data in PHP through Connect Server



Connect to HCL Domino through the standard SQL Server libraries in PHP.

You can use CData Connect Server to access HCL Domino data from SQL Server clients, without needing to perform an ETL or cache data. Follow the steps below to create a virtual SQL Server database for HCL Domino and connect to HCL Domino data in real time through PHP's standard SQL Server interface, i.e. sqlsrv_connect.

CData Connect Server provides a pure SQL Server interface for HCL Domino, allowing you to easily build reports from live HCL Domino data in PHP — without replicating the data to a natively supported database. As you build visualizations, PHP generates SQL queries to gather data. Using optimized data processing out of the box, CData Connect Server pushes all supported SQL operations (filters, JOINs, etc) directly to HCL Domino, leveraging server-side processing to quickly return the requested HCL Domino data.

Create a Virtual SQL Server Database for HCL Domino Data

CData Connect Server uses a straightforward, point-and-click interface to connect to data sources and generate APIs.

  1. Login to Connect Server and click Connections.
  2. Select "HCL Domino" from Available Data Sources.
  3. Enter the necessary authentication properties to connect to HCL Domino.

    Prerequisites

    The connector requires the Proton component to be installed. Normally, Proton is distributed as part of the AppDev pack. See the HCL documentation for instructions on acquiring and installing Proton or the AppDev pack.

    Once the Proton service is installed and running, you will also need to create a user account and download its Internet certificate. This certificate can be used to set the connector certificate connection properties.

    Authenticating to Domino

    • Server: The name or IP address of the server running Domino with the Proton service.
    • Port: The port number that the Proton service is listening on.
    • Database: The name of the database file, including the .nsf extension.
    • SSLClientCertType: This must match the format of the certificate file. Typically this will be either PEMKEY_FILE for .pem certificates or PFXFILE for .pfx certificates.
    • SSLClientCert: The path to the certificate file.
    • SSLServerCert: This can be set to (*) if you trust the server. This is usually the case, but if you want to perform SSL validation, you may provide a certificate or thumbprint instead. See the documentation for SSLServerCert for details.

    Additional Server Configuration

    The connector supports querying Domino views if any are defined. Before views can be queried by the connector they must be registered with the design catalog.

    Please refer to the Catalog Administration section of the AppDev pack documentation for details on how to do this.

  4. Click Save Changes
  5. Click Privileges -> Add and add the new user (or an existing user) with the appropriate permissions.

With the virtual database created, you are ready to connect to HCL Domino data from PHP.

Connect in PHP

The following examples show how to use object-oriented interfaces to connect and execute queries. Initialize the connection object with the following parameters to connect to the virtual SQL Server database:

  • Server name/Host: Specify the remote host location where the service is running.
  • Username: Specify the username for a user you authorized in Connect Server.
  • Password: Specify the password for the authorized user account.
  • Database Name: Specify the name of the virtual database you created for HCL Domino.
  • Port: Specify the port the service is running on, port 1433 in this example.

sqlsrv_connect

<?php
$serverName = "connect_server_url, 1433"; //Connect Server Address, portNumber (default is 1433)
$connectionInfo = array( "Database"=>"Domino1", "UID"=>"userName", "PWD"=>"password");
$conn = sqlsrv_connect( $serverName, $connectionInfo);

if( $conn ) {
     echo "Connection established.<br>";
}else{
     echo "Connection could not be established.<br>";
     die( print_r( sqlsrv_errors(), true));
}
?>

PDO

<?php
<?php
$user = my_connect_user
$pass = my_connect_pass

$pdo = new PDO("sqlsrv:Server=connect_server_url,1433;Database=Domino1", $user , $pass);

?>

Query in PHP

With the connection established, you can then access tables. The following steps walk through the example:

  1. Query the table; for example, ByName. The results will be stored as an associative array in the $result object.
  2. Iterate over each row and column, printing the values to display in the PHP page.
  3. Close the connection.

sqlsrv_connect

$result = $sqlsrv_connect->query("SELECT Name, Address FROM ByName WHERE City = 'Miami'");
while($row = $result->fetch_assoc()) {
  foreach ($row as $k=>$v) {
    echo "$k : $v";
    echo "<br>"; 
  }
}
$sqlsrv_connect->close();

PDO

$result = $pdo->query("SELECT Name, Address FROM ByName WHERE City = 'Miami'");
while($row = $result->fetch(PDO::FETCH_ASSOC)) {
  foreach ($row as $k=>$v) {
    echo "$k : $v";
    echo "<br>"; 
  }
}
$result = null;
$pdo = null;

SQL Server Access to HCL Domino Data using PHP

You have retrieved live HCL Domino Data using PHP. Now, you can easily access data sources and more — all without replicating HCL Domino data.

To get SQL data access to 200+ SaaS, Big Data, and NoSQL sources directly from your applications, try CData Connect Server.