How to create Anaplan federated tables in MySQL

You can use the SQL Gateway to configure a MySQL remoting service and set up federated tables for Anaplan data. The service is a daemon process that provides a MySQL interface to the CData ODBC Driver for Anaplan: After you have started the service, you can create a server and tables using the FEDERATED Storage Engine in MySQL. You can then work with Anaplan data just as you would local MySQL tables.

Connect to Anaplan Data

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

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.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to Anaplan data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.

Create a FEDERATED Server and Tables for Anaplan Data

After you have configured and started the service, create a FEDERATED server to simplify the process of creating FEDERATED tables:

Create a FEDERATED Server

The following statement will create a FEDERATED server based on the ODBC Driver for Anaplan. Note that the username and password of the FEDERATED server must match a user account you defined on the Users tab of the SQL Gateway.

CREATE SERVER fedAnaplan
FOREIGN DATA WRAPPER mysql
OPTIONS (USER 'sql_gateway_user', PASSWORD 'sql_gateway_passwd', HOST 'sql_gateway_host', PORT ####, DATABASE 'CData Anaplan Sys');

Create a FEDERATED Table

To create a FEDERATED table using our newly created server, use the CONNECTION keyword and pass the name of the FEDERATED server and the remote table (Sales). Refer to the following template for the statement to create a FEDERATED table:

CREATE TABLE fed_sales (
  ...,
  region  TYPE(LEN),
  product  TYPE(LEN),
  ...,
)
ENGINE=FEDERATED
DEFAULT CHARSET=latin1
CONNECTION='fedAnaplan/sales';

NOTE: The table schema for the FEDERATED table must match the remote table schema exactly. You can always connect directly to the MySQL remoting service using any MySQL client and run a SHOW CREATE TABLE query to get the table schema.

Execute Queries

You can now execute queries to the Anaplan FEDERATED tables from any tool that can connect to MySQL, which is particularly useful if you need to JOIN data from a local table with data from Anaplan. Refer to the following example:

SELECT 
  fed_sales.region, 
  local_table.custom_field 
FROM 
  local_table 
JOIN 
  fed_sales 
ON 
  local_table.foreign_region = fed_sales.region;