Connect to Anaplan Data as a SQL Server Linked Server
SQL Server Linked Servers enable the SQL Server Database Engine to read data from remote data sources and execute commands against the remote database servers outside of the instance of SQL Server. Typically, linked servers are configured to enable the execution of a T-SQL statement that includes tables in another instance of SQL Server, or another database product such as Oracle. When paired with CData Connect AI, linked servers provides instant access to Anaplan data from your SQL Server database. This article demonstrates how to connect to Anaplan using Connect AI and query Anaplan data in SQL Server Management Studio (SSMS).
CData Connect AI provides a pure SQL Server interface for Anaplan, allowing you to query data from Anaplan without replicating the data to a natively supported database. Using optimized data processing out of the box, CData Connect AI pushes all supported SQL operations (filters, JOINs, etc.) directly to Anaplan, leveraging server-side processing to return the requested Anaplan data quickly.
Configure Anaplan Connectivity for SQL Server
Connectivity to Anaplan from SQL Linked Servers is made possible through CData Connect AI. To work with Anaplan data from SQL Linked Servers, we start by creating and configuring a Anaplan connection.
- Log into Connect AI, click Sources, and then click Add Connection
- Select "Anaplan" from the Add Connection panel
-
Enter the necessary authentication properties to connect to Anaplan.
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.
- Click Save & Test
-
Navigate to the Permissions tab in the Add Anaplan Connection page and update the User-based permissions.
Add a Personal Access Token
When connecting to Connect AI through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect AI. It is best practice to create a separate PAT for each service to maintain granularity of access.
- Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
- On the Settings page, go to the Access Tokens section and click Create PAT.
-
Give the PAT a name and click Create.
- The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.
With the connection configured and a PAT generated, you are ready to connect to Anaplan data from .
Connect to Anaplan from SQL Server using Connect AI
To establish a connection from SQL Server Linked Server to the CData Connect AI Virtual SQL Server API, follow these steps.
- Open Microsoft SQL Server Management Studio.
- In the Object Explorer pane, open Server Objects, right-click Linked Servers, and select New Linked Server.
-
The New Linked Server dialogue opens. On the General page, enter the following information:
- Enter a name for the server in the Linked server field.
- Select the radio button Other data source and select SQL Server Native Client 11.0 as the provider.
- In the Data source field, enter tds.cdata.com,14333
- In the Catalog field, enter enter the Connection Name of the CData Connect AI data source you want to connect to (for example, Anaplan1).
-
Select the Security page. At the bottom, select the radio button labeled Be made using this security
context and enter the following information:
- Remote login - enter your CData Connect AI username. This is displayed in the top-right corner of the CData Connect AI interface. For example, [email protected].
- With password - enter the PAT you generated on the Settings page.
- Click OK to create the server. Your linked server can now be used to access the data in the data source you specified. If you need to access data from more sources, create another linked server for each one.
Execute Queries
You can now execute queries to the Anaplan linked server from any tool that can connect to SQL Server. An example SQL query would be:
SELECT * FROM [CDATA CONNECT CLOUD].[Anaplan1].[Anaplan].[Sales]
We have successfully created a linked server that allows us to query Anaplan data.
Get CData Connect AI
To get live data access to hundreds of SaaS, Big Data, and NoSQL sources directly from your SQL Server database, try CData Connect AI today!