Overview of the Excel Deephaven Add-In

Deephaven excels when processing live, streaming data that is constantly being updated – something Microsoft Excel cannot do alone. However, the Deephaven Excel Add-In allows such live data updates to be presented in Microsoft Excel as they arrive at the database, rather than limiting the user to only point-in-time snapshots.

After the Deephaven Excel Add-in is installed (see instructions below), the available features will be presented in the Deephaven "ribbon" within Microsoft Excel. As shown below, Deephaven will appear near the right side in the Excel menu, similar to the way other Excel add-ins are displayed.

Prerequisites

The Deephaven Excel Add-In is compatible with Microsoft Excel version 2007 or later, running in a Windows environment. At this point in time, Web and Mac versions of Microsoft Excel do not support this type of plugin.

The Deephaven Excel Add-In requires access to an API server for a Deephaven installation running version 1.20200331.192 or later.

Users of the Deephaven Excel Add-In must have a valid Deephaven username and password. The Deephaven Excel Add-In does not currently support single sign-on (SSO) options. Users who are not permissioned within Deephaven to be able to start a console will only be able to use the Persistent Query functions of the Deephaven Excel Add-In.

The Deephaven Excel Add-In uses features from .NET Framework version 4.7. If this version of the framework is not detected, the installer will ask to install an appropriate Framework version.

Installing the Deephaven Ribbon

Opening the Deephaven Excel Add-In installer launches the Windows Setup Wizard, as shown below:

Cick Next to begin the installation process. You will be asked to select an installation folder:

Follow the prompts to finish the installation.

After installing the Deephaven Excel Add-In, Microsoft Excel must be run one time with Administrator privileges to complete registration of the underlying component used for Excel’s built-in Real Time Data (RTD) function.

Logging In

When you start Excel with the Deephaven ribbon installed, most of the options will initially be disabled, other than Log In and the Settings options.

Clicking the Log In button will open the Connect to Deephaven panel, as shown below.

This panel has the following fields:

• URL - This field is used to enter the address of the Deephaven API to which you are connecting. This will usually be in the form wss://your.server.address:8123/socket. After you log in, the Deephaven ribbon will remember the last value you entered here as a convenience, so you should not need to enter it again.
• Username - This field is used to enter your Deephaven username. This is the username that a Deephaven administrator has set up within Deephaven. This is the same username you would use if you were logging into Deephaven via the Deephaven console or Web interface. After you log in, the Deephaven ribbon will remember the last value you entered here as a convenience, so you should not need to enter it again.
• Password - This field is used to enter your Deephaven password. This is the password you would use if you were attempting to log into Deephaven via the Deephaven console or Web interface. This password is not inherently linked to any single sign-on mechanism like your Windows password or network password. The Deephaven ribbon will not remember your password; you must enter it each time you log into the Deephaven Excel Add-In.

After you enter your information and log in, the Deephaven ribbon will then attempt to contact the specified URL and authenticate your credentials. If your credentials are accepted, the rest of the ribbon will be activated:

The ribbon includes the following sections:

• Get Data
• RTD
• SBE
• Settings