Excel COM Add-in Setup

The Excel COM Add-in setup simplifies the installation process by installing only the Excel and / or Office Add-in1.

Standard Installation

There are two options for installing the Excel / Office Add-in:

  1. Download the setup from the Cloud Console or the Jedox Customer Portal. An active internet connection is required for the installation. Once the installation is complete, you need to connect to the Jedox OLAP server via the Jedox Wizard button.

  1. If no internet connection is available during the installation, you can install the Offline Binaries, which are available from the Software Download section of the Customer Portal. To install the binaries after downloading them, the setup must be executed from the command line with the following parameters: JedoxExcelSetup_2x.x.exe /sourceexceladdin JedoxExcelAddin_2x_x.zip /sourceofficeaddin JedoxOfficeAddin_2x_x.zip. Note that the binaries must be in the same version as the Excel setup, available for the supported Jedox versions.

You must have administrative rights to the client system to perform the installation. The default installation path is C:/Program Files(86)/Jedox/Jedox Clients.

Silent Installation

For unattended / automatic installation, you can use a set of terminal commands and parameters.

  • JedoxExcelSetup.exe /silent

Starts a silent installation where only the installation progress is shown. When the installation is finished, the setup closes.

  • JedoxExcelSetup.exe /verysilent

Starts a silent installation where no window is displayed. When the installation is finished, the setup closes.

  • JedoxExcelSetup.exe /installationpath {PATH}

Allows you to change the installation directory. E.g:

JedoxExcelSetup.exe /silent /installationpath “C:/Program Files/Jedox”

  • /cert {PATH}

Changes the client certificate.

Note that in the setup these options also work without using /silent or /verysilent installation.

For uninstalling Excel / Office Add-in * you can also use the command-line parameters /silent, /verysilent, and /wipe:

  • UninstallExcelAddin.exe /silent

Uninstalls the Add-in and only one window with the progress bar is shown.

  • UninstallExcelAddin.exe /verysilent

Uninstalls the Add-in without displaying anything.

  • UninstallExcelAddin.exe /wipe

Uninstalls the Add-in.

  • In addition, the following directories will be removed:
    Jedox Clients/.install
    Jedox Clients/excel-addin/cert
    %APPDATA%/Jedox/xlAddin

  • In addition, the following registry trees will be deleted:
    HKEY_USERS/.DEFAULT/Software/Jedox
    HKEY_CURRENT_USER/SOFTWARE/Jedox

Note: The parameter /wipe will delete all user data and certificates saved in the Add-in. There is no way to restore these deleted files. Furthermore no fallback to the Add-in installation of an AIO setup is possible.

Changing the default connections

By default, the setup creates a connection file for the Excel / Office Add-in. The file does not contain any data. You can change the connection file by using the following command:

Copy
JedoxExcelSetup.exe /connectionspath {PATH/TO/CONNECTIONS.JSON}

The /connectionspath parameter can be used together with /silent or /verysilent.

The content of the connections.json file should look as follows:

Copy
[{
 "Name":"localhost",
 "Address":"http://127.0.0.1",
 "Username":"admin",
 "Password":"s+y9vcd9SYJYF6mnKw1KXA==",
 "WebPort":443,
 "OlapPort":443,
 "IsEnabled":true,
 "AuthenticationMode":0
}]
Parameter Description
Name The display name of the connection
Address The Domain or IP address of the server
Username Your Jedox Web username
Password Your Jedox Web password (encrypted using AES 256bit cbc)
WebPort The port of the Jedox Web server
OlapPort The port of the OLAP server
IsEnabled If true, the connection is made automatically upon login. If false, the connection must be manually enabled in the Connection Wizard
AuthenticationMode 0 = Username and password
1 = Windows authentication
2 = SAML authentication

* Notes:

  • When an Excel COM Add-in setup is installed over an existing AIO setup installation, the older version is not uninstalled. The older version's Add-in will be unregistered, and the Excel Add-in setup is registered. The Desktop, and Start Menu shortcuts are also updated with the new version.
  • When the Excel COM Add-in setup is uninstalled, the previous version is automatically re-registered, and the Desktop and Start Menu shortcuts will return to their previous state.
  • The Excel Add-in setup requires .Net Framework 4.7.2 or higher.

Updated September 27, 2024