Ready to get started?

Learn more about the CData ODBC Driver for SFTP or download a free trial:

Download Now

Use the CData ODBC Driver for SFTP in MicroStrategy Web

Connect to SFTP data in MicroStrategy Web using the CData ODBC Driver for SFTP.

MicroStrategy is an analytics and mobility platform that enables data-driven innovation. When you pair MicroStrategy with the CData ODBC Driver for SFTP, you gain database-like access to live SFTP data from MicroStrategy, expanding your reporting and analytics capabilities. In this article, we walk through adding SFTP as external data in MicroStrategy Web and creating a simple visualization of SFTP data.

The CData ODBC Driver offers unmatched performance for interacting with live SFTP data in MicroStrategy due to optimized data processing built into the driver. When you issue complex SQL queries from MicroStrategy to SFTP, the driver pushes supported SQL operations, like filters and aggregations, directly to SFTP and utilizes the embedded SQL engine to process unsupported operations (often SQL functions and JOIN operations) client-side. With built-in dynamic metadata querying, you can visualize and analyze SFTP data using native MicroStrategy data types.

Connect to SFTP as an ODBC Data Source

Information for connecting to SFTP follows, along with different instructions for configuring a DSN in Windows and Linux environments (the ODBC Driver for SFTP must be installed on the machine hosting the connected MicroStrategy Intelligence Server).

SFTP can be used to transfer files to and from SFTP servers using the SFTP Protocol. To connect, specify the RemoteHost;. service uses the User and Password and public key authentication (SSHClientCert). Choose an SSHAuthMode and specify connection values based on your selection.

Set the following connection properties to control the relational view of the file system:

  • RemotePath: Set this to the current working directory.
  • TableDepth: Set this to control the depth of subfolders to report as views.
  • FileRetrievalDepth: Set this to retrieve files recursively and list them in the Root table.
Stored Procedures are available to download files, upload files, and send protocol commands. See gdatamodel for more on using SQL to interact with the server.

When you configure the DSN, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

Windows

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.

Linux

If you are installing the CData ODBC Driver for SFTP in a Linux environment, the driver installation predefines a system DSN. You can modify the DSN by editing the system data sources file (/etc/odbc.ini) and defining the required connection properties.

/etc/odbc.ini

[CData SFTP Sys] Driver = CData ODBC Driver for SFTP Description = My Description RemoteHost = MyFTPServer

For specific information on using these configuration files, please refer to the help documentation (installed and found online).

Connect to and Visualize SFTP Data using MicroStrategy Web

Once you have created a database instance in MicroStrategy Developer and connected it to a project, you can perform a data import of SFTP data from MicroStrategy Web. Alternatively, you can create a new data source based on the ODBC Driver.*

  1. Open MicroStrategy Web and select your project.
  2. Click Add External Data, select Databases, and choose Select a Table as the Import Option.
  3. In the Import from Tables wizard, click to add a new data source.
    • Select DSN Data Sources
    • Set the DSN property to the previously configured DSN (CData SFTP Sys)
    • Set the Version property to Generic DBMS
    • Set the User and Password properties (or use filler values)
    • Set the Data Source Name
  4. After creating the data source, click to edit the catalog options and set the following queries and click OK.
    • SQL statement to retrieve tables available in the data source
      SELECT
        CatalogName NAME_SPACE,
        TableName TAB_NAME
      FROM
        SYS_TABLES
          
    • SQL statement to retrieve columns for the selected tables
      SELECT DISTINCT 
        CatalogName NAME_SPACE, 
        TableName TAB_NAME, 
        ColumnName COL_NAME, 
        DataTypeName DATA_TYPE, 
        Length DATA_LEN, 
        NumericPrecision DATA_PREC, 
        NumericScale DATA_SCALE 
      FROM 
        SYS_TABLECOLUMNS 
      WHERE 
        TableName IN (#TABLE_LIST#) 
      ORDER BY
        1,2,3
          
  5. Drag a table into the pane. Note: Since we create a live connection, we can import whole tables and utilize the filtering and aggregation features native to the MicroStrategy products.
  6. Click Finish, choose to the option to connect live, save the query, and choose the option to create a new dossier.
  7. Choose a visualization, choose fields to display, and apply any filters to create a new visualization of SFTP data. Data types are discovered automatically through dynamic metadata discovery. Where possible, the complex queries generated by the filters and aggregations will be pushed down to SFTP, while any unsupported operations (which can include SQL functions and JOIN operations) will be managed client-side by the CData SQL engine embedded in the driver.
  8. Once you have finished configuring the dossier, click File -> Save.

Using the CData ODBC Driver for SFTP in MicroStrategy Web, you can easily create robust visualizations and reports on SFTP data. Read our other articles on connecting to SFTP in MicroStrategy and connecting to SFTP in MicroStrategy Desktop for more examples.


Note: connecting using a ODBC driver requires a 3- or 4-tier architecture.