Skip to main content

10.1 Installing the Excel Add-In

The TDengine IDMP Excel Add-In allows you to retrieve time-series data and element attributes directly inside Microsoft Excel, without writing any code or SQL.

10.1.1 Prerequisites​

HTTPS Requirement​

The Excel Add-In connects to IDMP over HTTPS only. Before installing, ensure that the IDMP HTTPS service is enabled and accessible (default port: 6034).

To enable HTTPS, add the following to the IDMP configuration file (application.yml):

quarkus:
  http:
    port: 6042          # IDMP HTTP service port
    ssl-port: 6034      # IDMP HTTPS service port
    insecure-requests: enabled      # Allow both HTTP and HTTPS
    ssl:
      enabled: true     # Enable SSL/HTTPS
      certificate:
        files: /usr/local/taos/idmp/config/certbundle.pem   # Certificate file path
        key-files: /usr/local/taos/idmp/config/privkey.pem  # Private key file path

Built-in test certificate. IDMP ships with a test certificate valid for 3 months, bound to the domain idmp.tdengine.net. This certificate is suitable for evaluation and testing. It is not recommended for production use. To configure a self-signed certificate with a longer validity period, see Certificate Configuration.

If you are using the built-in test certificate, add the following entry to the hosts file on the client machine (replace the IP with your actual server address):

192.168.1.100  idmp.tdengine.net

Hosts file locations:

  • Linux / macOS: /etc/hosts
  • Windows: C:\Windows\System32\drivers\etc\hosts

System Requirements​

RequirementDetails
Excel versionExcel 2016 or later (Windows or macOS)
PermissionsAdministrator rights required on Windows
NetworkNetwork access is required to download the installation script and connect to the IDMP service
Node.jsNode.js 22.3 or later required on Windows if logging is enabled

10.1.2 Online Installation​

Open a terminal and run:

curl -LsSf https://taosinstallers.blob.core.windows.net/tdengine-excel-add-in/install.sh | sh -s install --force-close --url https://idmp.tdengine.net:6034 --enable-logging

Replace https://idmp.tdengine.net:6034 with your actual IDMP HTTPS address.

Parameters:

ParameterDescription
--force-closeForce-closes Excel during installation. Save your work before running.
--urlThe IDMP HTTPS service address
--enable-loggingEnables installation and runtime logging

Log file location: ~/Library/Containers/com.microsoft.Excel/Data/tdengine_eai.log

warning

Excel will be force-closed during installation. Save all open workbooks before running the command.

10.1.3 Offline Installation​

If the client machine cannot access the public internet, download the installation files on a machine with network access, then copy them to the target machine for installation.

Download Installation Files​

FileDownload URL
install.shinstall.sh
manifest.xmlmanifest.xml

On a machine with internet access, download the files (they can be saved to different directories). Create the directories first if they do not exist:

mkdir -p ~/Downloads ~/manifest
curl -fsSL https://taosinstallers.blob.core.windows.net/tdengine-excel-add-in/install.sh -o ~/Downloads/install.sh
curl -fsSL https://taosinstallers.blob.core.windows.net/tdengine-excel-add-in/manifest.xml -o ~/manifest/manifest.xml
chmod +x ~/Downloads/install.sh

Copy the downloaded files to the target macOS machine, then run:

~/Downloads/install.sh install --force-close --url https://idmp.tdengine.net:6034 --manifest-dir ~/manifest --enable-logging

Replace https://idmp.tdengine.net:6034, ~/Downloads/install.sh, and ~/manifest with your actual IDMP HTTPS address, install script path, and the directory containing manifest.xml.

Parameters:

ParameterDescription
--manifest-dirLocal directory containing manifest.xml; when set, the manifest is not downloaded from the network
--force-closeForce-closes Excel during installation. Save your work before running.
--urlThe IDMP HTTPS service address
--enable-loggingEnables installation and runtime logging
warning

Excel will be force-closed during installation. Save all open workbooks before running the command.

info

During offline installation, the target machine must still be able to reach the IDMP HTTPS service. Offline installation only avoids downloading the install script and manifest from the public internet.

10.1.4 Enabling and Disabling Logging​

To toggle logging independently of installation:

# Enable logging
curl -LsSf https://taosinstallers.blob.core.windows.net/tdengine-excel-add-in/install.sh | sh -s enable-logging-only --force-close

# Disable logging
curl -LsSf https://taosinstallers.blob.core.windows.net/tdengine-excel-add-in/install.sh | sh -s disable-logging-only --force-close

10.1.5 Uninstallation​

curl -LsSf https://taosinstallers.blob.core.windows.net/tdengine-excel-add-in/install.sh | sh -s uninstall --force-close
info

Uninstallation also force-closes Excel. Save all open workbooks before running the uninstall command.