Natively Connect to Anaplan Data in PHP

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

Configure a DSN

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

Authenticating to Anaplan

The driver supports authenticating with Basic, Certificate, or OAuth. In every case, set Region to the region where your Anaplan account data is hosted (e.g., US1, which is the default).

Using Basic Authentication

Set AuthScheme to Basic, then supply your Anaplan User and Password. If your workspace uses single sign-on (SSO), you must be assigned as an Exception User to use Basic authentication.

Using Certificate Authentication

Set AuthScheme to Certificate, then supply the Certificate, CertificateType, and PrivateKey properties (and the matching CertificatePassword / PrivateKeyPassword if either is encrypted). The certificate must be a CA-issued X.509 certificate registered with your Anaplan tenant administrator.

Using OAuth Authentication

Register a custom OAuth application in Anaplan, then set the following properties:

• OAuthClientId: The client Id assigned when you registered your custom OAuth application.
• OAuthClientSecret: The client secret assigned when you registered your custom OAuth application.
• CallbackURL: The redirect URI defined when you registered your application.
• InitiateOAuth: Set to GETANDREFRESH to have the driver manage the OAuth token exchange and refresh automatically.

See the Getting Started chapter of the help documentation for a guide to creating a custom OAuth app and using OAuth.

Establish a Connection

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

$conn = odbc_connect("CData ODBC Anaplan 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 Anaplan 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 Sales WHERE Value = ?");

Execute Queries

Execute prepared statements with odbc_execute.

$conn = odbc_connect("CData ODBC Anaplan Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM Sales WHERE Value = ?");
$success = odbc_execute($query, array('100'));
  

Execute nonparameterized queries with odbc_exec.

$conn = odbc_connect("CData ODBC Anaplan Source","user","password");
$query = odbc_exec($conn, "SELECT Region, Product FROM [Workspace].[Model].[Sales] WHERE Value = '100'");
  

Process Results

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

$conn = odbc_connect("CData ODBC Anaplan data Source","user","password");
$query = odbc_exec($conn, "SELECT Region, Product FROM [Workspace].[Model].[Sales] WHERE Value = '100'");
while($row = odbc_fetch_array($query)){
 echo $row["Region"] . "\n";
}

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

$conn = odbc_connect("CData ODBC Anaplan data Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM Sales WHERE Value = ?");
$success = odbc_execute($query, array('100'));
if($success)
  odbc_result_all($query);

More Example Queries

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