Installing the standalone Windows ODBC driver to connect a BI app to Luminesce

If you have a Windows computer and an ODBC-aware BI app such as Tableau or Excel, you can install the Luminesce ODBC driver to query Luminesce providers directly from a familiar interface.

Note

If you have Power BI Desktop from the Microsoft Store, it's quicker and easier to install the Luminesce Power BI Connector instead. If you have a non-Windows computer or a JDBC-aware BI app, see this article.

To do this, you require:

• Administrative privileges on a Windows 7 SP1+ computer

• .NET Framework 4.7.2+

Installing the driver

1. As a LUSID user with the lusid-administrator role, navigate to https://<your-domain>.lusid.com/honeycomb/swagger/index.html, where <your-domain> is the root of your LUSID domain, for example acmecorp. If you do not have the lusid-administrator role, see the appendix.

2. Use Swagger's Try it out button for the DownloadBinary API to request the Odbc_Win64_Driver binary:

   

3. Click the Download file link in the response to download the binary to your browser's download location:

   

4. Launch the MSI in your preferred way, for example at the command line:

   msiexec /i Finbourne.Luminesce.ODBCWin64.<version>.msi

   The MSI is currently unsigned, but it's safe to override any warnings:
    

5. On the Custom Setup screen, we recommend the default option of installing both 32-bit and 64-bit builds (even on a 64-bit system, since a typical Excel installation is 32-bit):
    

Configuring driver settings

If you installed the 64-bit build:

1. Search for the ODBC Data Sources (64-bit) app using the Windows Start menu:
    

2. In the ODBC Data Source Administrator (64-bit) dialog, open the System DSN tab and choose to Configure the 64-bit build (the 32-bit build is listed but must be configured using the equivalent ODBC Data Source Administrator (32-bit) dialog):
    

3. In the Luminesce ODBC Driver Configuration dialog, enter the prefix of your LUSID domain, for example acmecorp for an acmecorp.lusid.com domain:
    

4. Choose an authentication method:

   • If you want an interactive login using the OAuth 2.0 PKCE flow, retain the default Embedded web browser option in the User authentication area (to use a browser component based on IE), or choose System web browser (which may satisfy CORS requirement in some environments). End users are prompted to sign in to LUSID using their username, password and MFA type the first time they run a query in a BI app, and subsequent times on token expiry (some apps may spawn multiple processes, which may each cause authentication challenges to occur).

   • To authenticate silently using the OAuth 2.0 Resource Owner flow, enter your Client application ID and Client secret in the Service authentication area. You are prompted for your LUSID username and password when you set up the new data source or the first time you run a query (depending on the app), but not subsequently. Note the client secret is stored in the system registry in plain text. See how to generate a client ID and secret.

If you installed the 32-bit build as well, repeat steps 1-4 for that variant.

Using a BI app to query a Luminesce provider

The following example showcases using Excel to query the Lusid.Instrument provider supplied by FINBOURNE.

Note: An end user must have a valid LUSID user account and sufficient access control permissions to query the chosen providers. Find out more.

1. In Excel, select Get Data > From Other Sources > From ODBC from the Data menu:
    

2. In the From ODBC dialog, choose Luminesce from the Data source name dropdown:
    

3. When prompted, authenticate to LUSID using the username and password of a LUSID user.

4. In the Navigator dialog, choose one or more Luminesce providers to query, for example Lusid.Instrument:
    

5. Choose to Load data into Excel, for example:
    

Note you can write an explicit Luminesce SQL query in the Advanced options area of the From ODBC dialog (step 2). You can also specify parameters in the connection string in order to cache result data for faster execution:

Accessing logs

By default, logs are written to:

• 32-bit build: C:\Windows\Temp\FinbourneLuminesce\ODBC32Logs

• 64-bit build: C:\Windows\Temp\FinbourneLuminesce\ODBC64Logs

You can adjust the base directory (C:\Windows\Temp\FinbourneLuminesce) using the LOGPATH argument when running the MSI.

Uninstalling the driver

On Windows, you can uninstall the driver using Add or remove programs in the usual way, for example:

Appendix A: Allowing non-administrative users to download binaries

{
    "description": "User can download Power BI Connector and Windows ODBC Driver binaries",
    "applications": [
        "Honeycomb"
    ],
    "grant": "Allow",
    "selectors": [
        {
            "idSelectorDefinition": {
                "identifier": {
                    "code": "PowerBi_Connector",
                    "scope": "Honeycomb"
                },
                "actions": [
                    {
                        "scope": "Honeycomb",
                        "activity": "DownloadBinary",
                        "entity": "Feature"
                    }
                ],
                "name": "Power BI connector binary",
                "description": "User can download Power BI Connector binary"
            }
        },
        {
             "idSelectorDefinition": {
               "identifier": {
                    "code": "Odbc_Win64_Driver",
                    "scope": "Honeycomb"
                },
                "actions": [
                    {
                        "scope": "Honeycomb",
                        "activity": "DownloadBinary",
                        "entity": "Feature"
                    }
                ],
                "name": "Windows ODBC driver binary",
                "description": "User can download Windows ODBC driver binary"
            }
         }
    ],
    "when": {
        "activate": "2023-01-01T00:00:00.0000000+00:00",
        "deactivate": "9999-12-31T23:59:59.9999999+00:00"
    }
}