Installing and setting up the driver (Windows)

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.

1. Install the driver:

a. After downloading the product, unzip the installer files to a temporary directory.

b. From the installer directory, run the appropriate installer file to start the installer. The installer file takes the following form:

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.

2. 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).

3. 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."

4. 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 the your driver and click Finish to display the driver Setup dialog box.

File DSN: To configure a new file data source, click Add to display a list of installed drivers. Select your driver and click Advanced to specify attributes; otherwise, click Next to proceed. Specify a name for the data source and click Next. Verify the data source information; then, click Finish to display the driver Setup dialog box.

5. The Connection tab of the Configuration Manager opens in a window. Provide values for the following essential connection options; then, click Apply:

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.

Server Name: Type the base URL of the TeamCity instance to which you want to issue requests. For example, https://teamcity.company.com.

Authentication Method: Determines which authentication method the driver uses during the course of a session. Set to 0 - Basic. This is the default authentication method.

Password: Enter the password used to connect to your TeamCity service.

Important: The Password is a confidential value used to authenticate to the server. To prevent unauthorized access, this value must be securely maintained.

Authentication Method: Determines which authentication method the driver uses during the course of a session. Set to 34 - Bearer.

Security Token: Enter the security token used to connect to your TeamCity service.

Important: The security token is a confidential value used to authenticate to the server. To prevent unauthorized access, this value must be securely maintained.

6. 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 URL 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 property 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.

7. Click Test Connect to attempt to connect to the data source using the connection options.

8. If you are using Basic or Bearer token authentication, the logon dialog appears. Update the following fields; then, click OK.

Server Name: Enter the REST endpoint for the TeamCity service to which you are connecting with basic and bearer token authentication methods.

User Name: Enter the Active Directory user name that is used to connect to the service with basic authentication method.

Password: Enter the Active Directory password for your service with basic authentication method.

Security Token: Enter the security token used to connect to your TeamCity service with bearer token authentication method.

Note: The information you enter in the logon dialog box during a test connect is not saved.

9. If the test was successful, the window displays a confirmation message.

10. 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 Configure to modify your data source, or you can override these defaults by connecting to the data source using a connection string with alternate values.

11. Connect to your service 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.