Use the API Server and Clio ADO.NET Provider to Access Clio Data in Microsoft PowerPivot

This article will explain how to use the API Server and the ADO.NET Provider for Clio (or any of 200+ other ADO.NET Providers) to provide Clio data as OData services and then consume the data in Microsoft Excel's PowerPivot business intelligence tool. Follow the steps below to retrieve Clio data in Power Pivot.

Set Up the API Server

Follow the steps below to begin producing secure Clio OData services:

Deploy

The API Server runs on your own server. On Windows, you can deploy using the stand-alone server or IIS. On a Java servlet container, drop in the API Server WAR file. See the help documentation for more information and how-tos.

The API Server is also easy to deploy on Microsoft Azure, Amazon EC2, and Heroku.

Connect to Clio

After you deploy the API Server and the ADO.NET Provider for Clio, provide authentication values and other connection properties needed to connect to Clio by clicking Settings -> Connections and adding a new connection in the API Server administration console.

Start by setting the Profile connection property to the location of the Clio Profile on disk (e.g. C:\profiles\Clio.apip). Next, set the ProfileSettings connection property to the connection string for Clio (see below).

Clio API Profile Settings

Clio uses OAuth-based authentication.

First, register an OAuth application with Clio. You can do so by logging to your Developer Account and clicking the Add button. Enter details and select the scope of your application here - these details will be shown to Clio users when they're asked to authorize your application. Your Oauth application will be assigned a client id (key) and a client secret (secret). Additionally set the Region in ProfileSettings connection property.

After setting the following connection properties, you are ready to connect:

• AuthScheme: Set this to OAuth.
• InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
• OAuthClientId: Set this to the client_id that is specified in you app settings.
• OAuthClientSecret: Set this to the client_secret that is specified in you app settings.
• CallbackURL: Set this to the Redirect URI that is specified in your app settings.
• Region: Set this in ProfileSettings to your Clio geographic region. Defaults to app.clio.com.

You can then choose the Clio entities you want to allow the API Server access to by clicking Settings -> Resources.

Additionally, click Settings -> Server and set the Default Format to XML (Atom) for compatibility with Excel.

Authorize API Server Users

After determining the OData services you want to produce, authorize users by clicking Settings -> Users. The API Server uses authtoken-based authentication and supports the major authentication schemes. Access can also be restricted based on IP address; by default, only connections to the local machine are allowed. You can authenticate as well as encrypt connections with SSL.

Import Clio Tables in Power Pivot

Follow the steps below to import tables that can be refreshed on demand:

1. In Excel, click the PowerPivot Window icon in the PowerPivot tab to open PowerPivot.
2. Click Home -> Get External Data -> From Data Service -> From OData Data Feed.

3. Add authentication parameters. Click Advanced and set the Integrated Security option to Basic. You will need to enter the User Id and Password of a user who has access to the CData API Server. Set the password to the user's authtoken.

4. In the Base URL box, enter the OData URL of the CData API Server. For example, http://localhost:8032/api.rsc.

   

5. Select which tables you want to import and click Finish.

   

You can now work with Clio data in Power Pivot.