Installing and setting up the driver (Windows)
- Last Updated: September 27, 2023
- 5 minute read
- DataDirect Connectors
- ODBC
- Documentation
This section provides you with an overview of the steps required to install and set-up the driver. After completing this procedure, you will be able to begin accessing data with your application.
To begin accessing data with the driver:
-
Install the driver:
- After downloading the product, unzip the installer files to a temporary directory.
-
From the installer directory, run the
appropriate installer file to start the installer. The installer file takes
the following form:
PROGRESS_DATADIRECT_ODBC_nn_WIN_xx_INSTALL.exe
- Follow the prompts to complete installation.
Note:The installer program supports multiple installation methods, including command-line and silent installations. For detailed instructions, refer to the Progress DataDirect for ODBC Drivers Installation Guide.
- Before you can use your driver, you must set the PATH environment variable to include the path of the jvm.dll file of your Java™ Virtual Machine (JVM).
-
To configure the driver using the ODBC
Administrator (GUI), start the ODBC Administrator from the Progress DataDirect
program group. The GUI dialog allows you to configure the data source definitions in
the Windows Registry or generate connection strings.
Note: The Windows driver also supports using connection strings to connect to your service. For more information, see "Using a connection string."
-
Select either the User
DSN, System DSN, or
File DSN tab to display a list of data
sources.
- User
DSN: If you installed a default DataDirect ODBC user data source
as part of the installation, select the appropriate data source name and click
Configure to display the driver
Setup dialog box.
If you are configuring a new user data source, click Add to display a list of installed drivers. Select your driver and click Finish to display the driver Setup dialog box.
- System DSN: To configure a new system data source, click Add to display a list of installed drivers. Select your driver and click Finish to display the driver Setup dialog box.
- File DSN: Configuring a new file data source using the File DSN tab is not currently supported with the configuration manager.
- User
DSN: If you installed a default DataDirect ODBC user data source
as part of the installation, select the appropriate data source name and click
Configure to display the driver
Setup dialog box.
-
The Connection tab of the Configuration Manager opens in a window.
Provide values for the following essential connection options; then, click
Apply:
For all connections:
- Data Source Name: Type a string that identifies this data source configuration, such as Projects.
- Description: Type an optional long description of a data source name, such as My Development Projects.
- Host Name: (Optional) Specify the name or
the IP address of the server to which you want to connect. For example:
https://analyticsdata.googleapis.com.
For OAuth 2.0 refresh token grant:- Client ID: Specify the client ID key for your application when authenticating to Google Analytics.
- Client Secret: Specify the client secret for your application when authenticating to Google Analytics.
- Refresh Token: Specify the refresh token used to either request a new access token or renew an expired access token for OAuth 2.0 implementations.
Note:- You can fetch tokens using the Configuration Manager .See OAuth 2.0 Authentication for more information.
- Client ID, Client Secret, and Refresh Token connection options can also be specified in the logon dialog box or passed by your application.
- The driver supports a number of authentication methods. See OAuth 2.0 Authentication for more information.
-
Define the tables in the relational schema of your Google
Analytics data.
For more information about custom tables, and how they can be used to write useful queries, see Introduction to the Google Analytics Data Model.
- On the Schema Settings tab, click Configure Logical Schema.
-
Select values for the following drop-down fields:
- Account ID: The account ID used to filter the contents of the table.
- Property ID: The property ID used to filter the contents of the table.
-
Click the Create Table button.
In the Create Table window, specify the name of
table you want to create in the Table Name field;
then, click Create
Note: If you are editing an existing table that is specified by the Add Tables field in the connection string, select the table from the Select Table drop-down field.
- Select the metrics and dimensions you want to expose with the table. You may specify up to ten metrics and seven dimensions per table.
-
Click Save &
Close.
Result: The Add Tables field is populated with a table definition in the form of a JSON string, and the Default Query Options field is populated with parameters used for WHERE clause filtering.
-
Set the values for any additional connection options
that you want to configure. To view more options, click on the tabs on the dialog.
See the following resources for additional information on optional features and
functionality:
- Connection string examples provides connection string examples that can be used to configure common functionality and features. The options and values described in this section apply to all configuration methods.
- Connection option descriptions provides a complete list of supported options by functionality.
- Configuring data sources with the Configuration Manager guides you through using the GUI to configure the driver.
- Performance considerations describes connection options that affect performance, along with recommended settings.
Note: For most connections, specifying the minimum required connection options is sufficient to begin accessing data; however, you can provide values for optional connection options to use additional supported features and improve performance. - Click Test Connect to attempt to connect to the data source using the connection options.
-
The logon dialog appears. If not already specified, update the fields
provided; then, click OK.
Note: The information you enter in the logon dialog box during a test connect is not saved.
- If the test was successful, the window displays a confirmation message.
- Click OK to close the setup dialog. The values you have specified are saved and are the defaults used when you connect to the data source. You can change these defaults by using the Configuration Manager to modify your data source, or you can override these defaults by connecting to the data source using a connection string with alternate values.
-
Connect to your instance and begin
accessing data with your applications, BI tools, database tools, and more. To help
you get started, the following resources guide you through accessing data with some
common tools:
- Example Application: The example application allows you to test connect, execute SQL statements, and practice using the ODBC API right out of the box.
- Power BI: Power BI is a business intelligence software program that allows you to generate analytics and visualized representations of your data.
- Tableau: Tableau is a business intelligence software program that allows you to easily create reports and visualized representations of your data.
- Microsoft Excel: Excel is a spreadsheet tool that allows you to connect, view tables, and execute SQL statements against your data.
- Supported SQL statements and extensions: This section describes the syntax used for SQL statements supported by the driver. You can modify and use the provided examples for your application or tool.
This completes the deployment of the driver.