Use the CData JDBC Driver for Act CRM in MicroStrategy

MicroStrategy is an analytics and mobility platform that enables data-driven innovation. When you pair MicroStrategy with the CData JDBC Driver for Act CRM, you gain database-like access to live Act CRM data from MicroStrategy, expanding your reporting and analytics capabilities. In this article, we walk through creating a database instance for Act CRM in MicroStrategy Developer and create a Warehouse Catalog for the Act CRM data.

The CData JDBC Driver offers unmatched performance for interacting with live Act CRM data in MicroStrategy due to optimized data processing built into the driver. When you issue complex SQL queries from MicroStrategy to Act CRM, the driver pushes supported SQL operations, like filters and aggregations, directly to Act CRM 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 Act CRM data using native MicroStrategy data types.

Connect to Act CRM in MicroStrategy Developer

You can connect to Act CRM in MicroStrategy Developer by adding a database instance based on the CData JDBC Driver for Act CRM.^* Before you begin, you will need to install the JDBC Driver for Act CRM on the machine hosting the MicroStrategy Intelligence Server that your instance of MicroStrategy Developer is connected to.

1. Open MicroStrategy Developer and select a Project Source.
2. Navigate to Administration -> Configuration Managers -> Database Instances and right-click to add a new instance.
3. Name the instance, select Generic DBMS as the database connection type, and create a new database connection.
4. In the database connection wizard, name the connection and create a new Database Login name, setting the user and password for Act CRM.
5. On the Advanced tab for the connection wizard, set the additional connection string parameters as follows.
   • Add the JDBC keyword to the connection string.
   • Set MSTR_JDBC_JAR_FOLDER to the path of the directory containing the JAR file for the JDBC driver. (C:\Program Files\CData JDBC Driver for Act CRM\lib\ on Windows.)
   • Set DRIVER to cdata.jdbc.actcrm.ActCRMDriver, the driver class.
   • Set URL to the JDBC URL for the Act CRM driver, which contains the necessary connection properties.

     The User and Password properties, under the Authentication section, must be set to valid Act! user credentials. In addition to the authentication values, see the following:

     • Connecting to Act! Premium

       In addition to the authentication values, the URL to Act! is also required; for example https://eup1-iis-04.eu.hosted.act.com/.

       Additionally, you must specify the ActDatabase you will connect to. This is found by going to the About Act! Premium menu of your account, at the top right of the page, in the ? menu. Use the Database Name in the window that appears.

     • Connecting to Act! Premium Cloud

       To connect to your Act! Premium Cloud account, you also need to specify the ActCloudName property. This property is found in the URL address of the Cloud account; for example https://eup1-iis-04.eu.hosted.act.com/ActCloudName/.

     Note that retrieving ActCRM metadata can be expensive. It is advised that you set the CacheMetadata property to store the metadata locally.

     Built-in Connection String Designer

     For assistance in constructing the JDBC URL, use the connection string designer built into the Act CRM JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

     java -jar cdata.jdbc.actcrm.jar

     Fill in the connection properties and copy the connection string to the clipboard.

     When you configure the JDBC URL, 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.

   Typical additional connection string properties follow:

   JDBC;MSTR_JDBC_JAR_FOLDER=PATH\TO\JAR\;DRIVER=cdata.jdbc.actcrm.ActCRMDriver;URL={jdbc:actcrm:URL=https://myActCRMserver.com;User=myUser;Password=myPassword;ActDatabase=MyDB;};
6. Ensure that you have not selected an ODBC data source (this will trigger MicroStrategy to use the additional connection string parameters to build the database instance) and click OK.
7. Click OK to close the database instance wizard.
8. In the Project Source, right-click the project and open the Project configuration.
9. Navigate to Database Instances, select the newly created database instance, and click OK.
10. Close MicroStrategy Developer and restart the connected MicroStrategy Intelligence Server to complete the database instance creation.

With the database instance configured, you will now be able to connect to Act CRM data from the Warehouse Catalog and Data Import.

Connect to Act CRM Data from the Warehouse Catalog

Once you have created a database instance based on the JDBC Driver for Act CRM, you can connect to data from the Warehouse Catalog.

1. Select your project and click Schema -> Warehouse Catalog.
2. In the Read Settings for the Catalog, click Settings and set the queries to retrieve the schema:
   • To retrieve the list of tables, use the following query: SELECT * FROM SYS_TABLES
   • To retrieve the list of columns for selected tables, use the following query: 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
3. Select tables to be used in the project.

Using the CData JDBC Driver for Act CRM in MicroStrategy, you can easily create robust visualizations and reports on Act CRM data. Read our other articles on connecting to Act CRM in MictroStrategy Web and connecting to Act CRM in MicroStrategy Desktop for more information.

Note: Connecting using a JDBC Driver requires a 3- or 4-Tier Architecture.