Litmus Excel AddIns
Litmus DataHub AddIns

Define DataHub Connections

5min

To establish your first database connection in Litmus Excel Add-ins, you must configure the DataHub connection, check the firewall settings, and confirm successful communication with your database.

Before You Begin

  • You know the IPv4 address of your Litmus Edge device or of your external Database server.
  • Your firewall allows connections through port 8086, and the database supports InfluxDB v1 with read privileges for the database.
  • You have installed the Litmus Excel Add-ins extension. See Install Litmus Excel Add-ins for details.

Step 1: Navigate to DataHub Connections

  1. Open a new Excel file with Litmus Excel Add-ins enabled. See Step 4: Verify Litmus Excel Add-in Activation in Excel to learn more.
  2. Click on Manage DataHub Connections.

    Document image
    
  3. The Litmus DataHub Connections window pops up. You can take the following actions from this page:
    • Add a New Connection: See Step 2 (Next Step) below for detailed steps.
    • Learn more: This Add-in only supports connections using InfluxDB v1. You can access the InfluxDB Documentation through this link.
      • Note: Skip verification when the Advanced Threat Protection dialog box appears.

        Document image
        

Important: When trying to define a query, if no connections are defined, a message will appear indicating that no data sources are available.

Document image


Step 2: Add a New Connection

  1. Click on Add to create a new DataHub connection.

    Document image
    
  2. Enter the following details:
    • Litmus DataHub Server IPv4: Enter the following:
      • The API for InfluxDB v1 only supports IPv4 addresses.
      • To access our internal tsdata database, use the IPv4 address of your edge device.
      • For this guide, we use our internal tsdata database.
    • Litmus DataHub Port: Default is 8086 (change if using an external database). See Manage the Timeseries DB for details.
    • Litmus DataHub Database: Default is tsdata (change if using an external database). See Manage the Timeseries DB for details.
    • Litmus DataHub User: Enter the user's name credentials for tsdata database. See Add Database Users for more details.
    • Litmus DataHub Password: Enter the user's password credentials for tsdata database. See Add Database Users for more details.
    • Timeout in Seconds: The time the connection will wait before reporting an error.
    • Connection Name: A unique name to identify your connection.
    • If everything is configured correctly, you will see the message "Litmus DataHub & DB reachable" in green at the bottom.
      • Click Save to store the connection.

        Document image
        
  3. The connection will now appear in the Litmus DataHub Connections list.

    Document image
    

Your first database connection is now set up and ready for use in Litmus DataHub.

Configure Firewall Settings

Ensure that the specified port is open and not blocked by firewall rules to prevent connection issues.

If using Litmus Edge v3.16.5 or later, you must configure firewall rules to allow traffic on port 8086.

  • Navigate to System > Network > Firewall and add a new rule for port 8086. See Manage Firewall Rules for details.
  • If using an external database, configure the respective firewall settings. See InfluxDB ports for more details.

Troubleshooting

The system will attempt to establish a connection with the database. If successful, you will see a confirmation message. If the connection fails, it is best to: