Use Dash to Build Web Apps on SQL Analysis Services Data via CData Connect AI

The rich ecosystem of Python modules lets you get to work quickly and integrate your systems more effectively. With the CData Connect AI Python SDK, the pandas module, and the Dash framework, you can build SQL Analysis Services-connected web applications for SQL Analysis Services data. This article shows how to connect to Connect AI and use pandas and Dash to build a simple web app for visualizing SQL Analysis Services data.

The Connect AI Python SDK (cdata-connect-ai) is a DB-API 2.0 (PEP 249) compliant client, so pandas can read query results directly from the SDK connection object. There is no driver to install per source: connect with a Personal Access Token and build your app.

Connect to SQL Analysis Services in Connect AI

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

1. Log into Connect AI, click Sources, and then click Add Connection

2. Select "SQL Analysis Services" from the Add Connection panel

3. Enter the necessary authentication properties to connect to SQL Analysis Services.

   To connect, provide authentication and set the Url property to a valid SQL Server Analysis Services endpoint. You can connect to SQL Server Analysis Services instances hosted over HTTP with XMLA access. See the Microsoft documentation to configure HTTP access to SQL Server Analysis Services.

   To secure connections and authenticate, set the corresponding connection properties, below. The data provider supports the major authentication schemes, including HTTP and Windows, as well as SSL/TLS.

   • HTTP Authentication

     Set AuthScheme to "Basic" or "Digest" and set User and Password. Specify other authentication values in CustomHeaders.

   • Windows (NTLM)

     Set the Windows User and Password and set AuthScheme to "NTLM".

   • Kerberos and Kerberos Delegation

     To authenticate with Kerberos, set AuthScheme to NEGOTIATE. To use Kerberos delegation, set AuthScheme to KERBEROSDELEGATION. If needed, provide the User, Password, and KerberosSPN. By default, the data provider attempts to communicate with the SPN at the specified Url.

   • SSL/TLS:

     By default, the data provider attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store. To specify another certificate, see the SSLServerCert property for the available formats.

   You can then access any cube as a relational table: When you connect the data provider retrieves SSAS metadata and dynamically updates the table schemas. Instead of retrieving metadata every connection, you can set the CacheLocation property to automatically cache to a simple file-based store.

   See the Getting Started section of the CData documentation, under Retrieving Analysis Services Data, to execute SQL-92 queries to the cubes.

   
4. Click Save & Test
5. Navigate to the Permissions tab and update the user-based permissions.

Generate a Personal Access Token (PAT)

The Python SDK authenticates to Connect AI with your account email and a Personal Access Token (PAT). It is best practice to create a separate PAT for each application to maintain granularity of access.

1. Click the Gear icon () at the top right of the Connect AI app to open the Settings page.
2. On the Settings page, go to the Access Tokens section and click Create PAT.
3. Give the PAT a name and click Create.
4. The PAT is only visible at creation, so copy it and store it securely.

Install Required Modules

Install the SDK (with the pandas extra), Dash, and Plotly using the pip utility:

pip install "cdata-connect-ai[full]"
pip install dash
pip install plotly

Build a Web App on SQL Analysis Services Data in Python

Once the required modules are installed, you are ready to build the web app. Code snippets follow, but the full source code is available at the end of the article.

First, import the modules, then connect to Connect AI with your account email and PAT and read SQL Analysis Services data into a DataFrame. Identifiers are three-part: <Connection>.<Schema>.<Table>, where the connection name defaults to the source name (for example, SSAS1).

import dash
from dash import dcc, html
import pandas as pd
import plotly.graph_objs as go
import cdata_connect_ai

conn = cdata_connect_ai.connect(
    username="[email protected]",
    password="<your_pat>",
)

df = pd.read_sql(
    "SELECT Fiscal_Year, Sales_Amount "
    "FROM [SSAS1].[SSAS].[Adventure_Works] "
    "WHERE Fiscal_Year = 'FY 2008'",
    conn,
)

conn.close()

Configure the App and Layout

With the query results stored in a DataFrame, build a bar graph from the SQL Analysis Services data and configure the app layout.

app = dash.Dash(__name__)
app.title = 'CData Connect AI + Dash'

trace = go.Bar(x=df['Fiscal_Year'], y=df['Sales_Amount'], name='Fiscal_Year')

app.layout = html.Div(
    children=[
        html.H1("CData Connect AI + Dash", style={'textAlign': 'center'}),
        dcc.Graph(
            id='example-graph',
            figure={
                'data': [trace],
                'layout': go.Layout(title='SQL Analysis Services Adventure_Works Data', barmode='stack'),
            },
        ),
    ],
    className="container",
)

Set the App to Run

With the connection, app, and layout configured, you are ready to run the app.

if __name__ == '__main__':
    app.run(debug=True)

Now, use Python to run the web app and a browser to view the SQL Analysis Services data.

python ssas-dash.py

More Information and Free Trial

Now you can build interactive Dash web apps on live SQL Analysis Services data using the CData Connect AI Python SDK. For more information on connecting to SQL Analysis Services (and hundreds of other data sources), visit the Connect AI page. Sign up for a free trial and start building web apps on live SQL Analysis Services data in Python.

Full Source Code

import dash
from dash import dcc, html
import pandas as pd
import plotly.graph_objs as go
import cdata_connect_ai

conn = cdata_connect_ai.connect(
    username="[email protected]",
    password="<your_pat>",
)

df = pd.read_sql(
    "SELECT Fiscal_Year, Sales_Amount "
    "FROM [SSAS1].[SSAS].[Adventure_Works] "
    "WHERE Fiscal_Year = 'FY 2008'",
    conn,
)

conn.close()

app = dash.Dash(__name__)
app.title = 'CData Connect AI + Dash'

trace = go.Bar(x=df['Fiscal_Year'], y=df['Sales_Amount'], name='Fiscal_Year')

app.layout = html.Div(
    children=[
        html.H1("CData Connect AI + Dash", style={'textAlign': 'center'}),
        dcc.Graph(
            id='example-graph',
            figure={
                'data': [trace],
                'layout': go.Layout(title='SQL Analysis Services Adventure_Works Data', barmode='stack'),
            },
        ),
    ],
    className="container",
)

if __name__ == '__main__':
    app.run(debug=True)