Install Self-Service Analytics - Windows

This section provides instructions for performing a clean installation of your software in your Windows Server environment.

Windows Environment

This section provides instructions for performing a clean installation of Self-Service Analytics in your Windows Server environment.

For information about the difference between a clean installation of Self-Service Analytics and an upgrade to the latest GA release, see Clean Installation and Upgrade Differences.

Upgrade and Migration Considerations

• Windows Server 2012R2 is not compatible with both Java17 binaries and the latest releases of Self-Service Analytics. We recommend you use Windows 2019 or later.
• In general, you can upgrade directly to the latest version of Self-Service Analytics from a prior version of Composer.
• If you are upgrading to a newer version of Self-Service Analytics and you also want to change your encryption mode, perform the upgrade first and then complete the steps described in Encryption.

New installations of Self-Service Analytics use PostgreSQL 16. If you are upgrading your environment to Self-Service Analytics, you can retain your existing PostgreSQL version.

If you are upgrading to a newer version of Self-Service Analytics and have created an attribute named User.timeZone, this may be overwritten on upgrade. See Upgrade Workflow for more information about preparing your environment for the upgrade process.

In general, the installation process is automated and you only need to run an installation script. The installation script is implemented using Bootstrap. This script accesses a dedicated Self-Service Analytics repository and automatically downloads all the necessary components to install your Self-Service Analytics microservice.

By default, the bootstrap script installs these core components, connectors, and required dependencies:

• Zoomdata web application
• Query Engine
• MSSQL
• Mongo DB
• Elastic 7
• Solr
• Cloudera Search
• Consul
• PostgreSQL 16
• Corretto JDK17
• Chocolatey

To install other components, adjust bootstrap switches as needed. See Windows Bootstrap Reference, Self-Service Analytics Microservice Name Reference and Data Connector Reference.

After the installation has completed, you need to activate the Self-Service Analytics microservices, download and configure a JDBC driver if you are using specific data sources (see Post-Installation Options for a list), and open a browser window and enter the specific IP address to access the Self-Service Analytics client.

Review and complete (as appropriate for your installation) the following installation information:

• Plan Your Installation
• Installation Steps
• Post-Installation Options
• Access and Use Self-Service Analytics

Windows Bootstrap Reference

The Windows bootstrap installation script installs, by default, these components for Self-Service Analytics:

Core components:

• Zoomdata web application
• Query Engine
• Consul

Mandatory dependencies:

• Corretto JDK17
• PostgreSQL 16

New installations of Self-Service Analytics use PostgreSQL 16. If you are upgrading your environment to Self-Service Analytics, you can retain your existing PostgreSQL version.

Other components:

• MSSQL
• Mongo DB
• Elastic 7
• Solr
• Cloudera Search
• Chocolatey

Add or remove other components or adjust optional components using bootstrap switches. For further help with the bootstrap script, run Get-Help ./bootstrap-composer.ps1 for syntax help or Get-Help ./bootstrap-composer.ps1 -Full for extended parameter help.

When you upgrade Self-Service Analytics, all services are stopped before the upgrade is installed, and can not be accessed by users until the upgrade is complete and services restarted.

Installation Parameters

Parameter	Description	Notes
-InstallDestinationPath	The path to install Self-Service Analytics files.
-ComposerVersion	The version of Self-Service Analytics to install.	latest Install the most recent version of Self-Service Analytics available. X.x Install the most recent version of Self-Service Analytics available for that trunk line (for example, 26.3. X.x.x Install the exact patch version of Self-Service Analytics specified (for example, 26.3.1.
-ComposerRepository	The repository to connect to for installation manifests and binary packages for Self-Service Analytics.	Official Self-Service Analytics repository: <https://composer-repo.logianalytics.com.
-ConnectorsList	A comma separated list of connectors to install.	By default, MSSQL, PostgreSQL, MongoDB, Elasticsearch 7.0, Apache Solr, and Cloudera Search are installed if you make no changes to the initial script. If you include connectors with this parameter, only those connectors are installed. Include the default connectors to install those as well. If you run the script with new connectors added using this parameter, the new connectors included are added to the existing installed connectors. See Data Connector Reference.
-AdditionalComponentsList	A comma separated list of additional services to install.	Include one or more of the following services. By default, all are included if you make no changes to the initial script. data-writer-mssql data-writer-postgresql screenshot-service zoomdata-admin-server zoomdata-config-server If you install the screenshot-service, Google Chrome and the Chrome driver are installed as well.
-PostgreSQLHost	The hostname or IP address of your external PostgreSQL server (configured for Self-Service Analytics metadata storage).	By default, localhost, which installs a new instance of PostgreSQL. PostgreSQL 16 for version 26.3 and later
-PostgreSQLTCP	The TCP port of your external PostgreSQL server (configured for Self-Service Analytics metadata storage).
-PostgreSQLUser	The PostgreSQL user name configured as owner of your Composer database.
-PostgreSQLPass	The PostgreSQL password for the user configured as owner of your Composer database.
-ServicesAction	Manage Windows services for Self-Service Analytics. You can perform this without performing other bootstrap activities.	Use on one or more services as needed. Actions include: install start stop restart status uninstall
-SkipDependenciesInstall	Set to skip installing Self-Service Analytics dependencies.	Chocolatey PostgreSQL 16 Google Chrome Google Chrome Driver
-SkipComposerInstall	Set to skip installing Self-Service Analytics services.	Download, extract, and configure actions are the only actions performed.
-SkipComposerConfigure	Set to skip configuring Self-Service Analytics services.	Download, extract, and install actions are the only actions performed.
-SkipComposerStart	Set to perform all installation actions, but do not start Self-Service Analytics services.
-SkipMetadataDumpOnUpgrade	Set to disable automatic metadata dumping during upgrade or installation of Self-Service Analytics services.
-DumpComposerMetadata	This is a separate action to perform a metadata dump. You must stop all services first to ensure consistency.	After stopping all services, you can perform this without performing other bootstrap activities.
-DeinstallComposer	Completely remove all Self-Service Analytics components and dependencies from this instance.
-PreDownloadedPackagesPath	Set to install Self-Service Analytics binaries from the defined path instead of downloading from the Self-Service Analytics repository.	The folder you point to must include all core components, required connectors, and additional services.
-BootstrapLogFile	Set to define an alternative path to record the bootstrap logs.	By default, the log file is put in the same folder you use to launch the bootstrap script.

Manual install of Self-Service Analytics is not currently supported for Windows environments.

See Post-Installation Options for more information and links to instructions.

Installation Examples

Install the most recent rapid release version of Self-Service Analytics and PostgreSQL as a dependency. Includes Impala and MSSQL EDC connectors and the MSSQL-based data writer service to c:\logi-composer. All components are started after installation.

./bootstrap-composer.ps1 -ComposerVersion latest -ConnectorsList impala,mssql -AdditionalComponentsList data-writer-mssql

Install only core components (Consul, Self-Service Analytics Server, Query Engine) of the most recent released Self-Service Analytics version in the 26.3 trunk. Default EDC connectors are installed (MSSQL, PostgreSQL, Mongo DB, Elastic 7, Solr, Cloudera Search).

./bootstrap-composer.ps1 -ComposerVersion 26.3

Install the most recent published long term support version of Self-Service Analytics. Do not start services.

./bootstrap-composer.ps1 -ComposerVersion latest-lts -SkipComposerStart

Windows Bootstrap Reference

The Windows bootstrap installation script installs, by default, these components for Self-Service Analytics:

Core components:

• Zoomdata web application
• Query Engine
• Consul

Mandatory dependencies:

• Corretto JDK17
• PostgreSQL 16

New installations of Self-Service Analytics use PostgreSQL 16. If you are upgrading your environment to Self-Service Analytics, you can retain your existing PostgreSQL version.

Other components:

• MSSQL
• Mongo DB
• Elastic 7
• Solr
• Cloudera Search
• Chocolatey

Add or remove other components or adjust optional components using bootstrap switches. For further help with the bootstrap script, run Get-Help ./bootstrap-composer.ps1 for syntax help or Get-Help ./bootstrap-composer.ps1 -Full for extended parameter help.

When you upgrade Self-Service Analytics, all services are stopped before the upgrade is installed, and can not be accessed by users until the upgrade is complete and services restarted.

Installation Parameters

Parameter	Description	Notes
-InstallDestinationPath	The path to install Self-Service Analytics files.
-ComposerVersion	The version of Self-Service Analytics to install.	latest Install the most recent version of Self-Service Analytics available. X.x Install the most recent version of Self-Service Analytics available for that trunk line (for example, 26.3. X.x.x Install the exact patch version of Self-Service Analytics specified (for example, 26.3.1.
-ComposerRepository	The repository to connect to for installation manifests and binary packages for Self-Service Analytics.	Official Self-Service Analytics repository: <https://composer-repo.logianalytics.com.
-ConnectorsList	A comma separated list of connectors to install.	By default, MSSQL, PostgreSQL, MongoDB, Elasticsearch 7.0, Apache Solr, and Cloudera Search are installed if you make no changes to the initial script. If you include connectors with this parameter, only those connectors are installed. Include the default connectors to install those as well. If you run the script with new connectors added using this parameter, the new connectors included are added to the existing installed connectors. See Data Connector Reference.
-AdditionalComponentsList	A comma separated list of additional services to install.	Include one or more of the following services. By default, all are included if you make no changes to the initial script. data-writer-mssql data-writer-postgresql screenshot-service zoomdata-admin-server zoomdata-config-server If you install the screenshot-service, Google Chrome and the Chrome driver are installed as well.
-PostgreSQLHost	The hostname or IP address of your external PostgreSQL server (configured for Self-Service Analytics metadata storage).	By default, localhost, which installs a new instance of PostgreSQL. PostgreSQL 16 for version 26.3 and later
-PostgreSQLTCP	The TCP port of your external PostgreSQL server (configured for Self-Service Analytics metadata storage).
-PostgreSQLUser	The PostgreSQL user name configured as owner of your Composer database.
-PostgreSQLPass	The PostgreSQL password for the user configured as owner of your Composer database.
-ServicesAction	Manage Windows services for Self-Service Analytics. You can perform this without performing other bootstrap activities.	Use on one or more services as needed. Actions include: install start stop restart status uninstall
-SkipDependenciesInstall	Set to skip installing Self-Service Analytics dependencies.	Chocolatey PostgreSQL 16 Google Chrome Google Chrome Driver
-SkipComposerInstall	Set to skip installing Self-Service Analytics services.	Download, extract, and configure actions are the only actions performed.
-SkipComposerConfigure	Set to skip configuring Self-Service Analytics services.	Download, extract, and install actions are the only actions performed.
-SkipComposerStart	Set to perform all installation actions, but do not start Self-Service Analytics services.
-SkipMetadataDumpOnUpgrade	Set to disable automatic metadata dumping during upgrade or installation of Self-Service Analytics services.
-DumpComposerMetadata	This is a separate action to perform a metadata dump. You must stop all services first to ensure consistency.	After stopping all services, you can perform this without performing other bootstrap activities.
-DeinstallComposer	Completely remove all Self-Service Analytics components and dependencies from this instance.
-PreDownloadedPackagesPath	Set to install Self-Service Analytics binaries from the defined path instead of downloading from the Self-Service Analytics repository.	The folder you point to must include all core components, required connectors, and additional services.
-BootstrapLogFile	Set to define an alternative path to record the bootstrap logs.	By default, the log file is put in the same folder you use to launch the bootstrap script.

Manual install of Self-Service Analytics is not currently supported for Windows environments.

See Post-Installation Options for more information and links to instructions.

Installation Examples

Install the most recent rapid release version of Self-Service Analytics and PostgreSQL as a dependency. Includes Impala and MSSQL EDC connectors and the MSSQL-based data writer service to c:\logi-composer. All components are started after installation.

./bootstrap-composer.ps1 -ComposerVersion latest -ConnectorsList impala,mssql -AdditionalComponentsList data-writer-mssql

Install only core components (Consul, Self-Service Analytics Server, Query Engine) of the most recent released Self-Service Analytics version in the 26.3 trunk. Default EDC connectors are installed (MSSQL, PostgreSQL, Mongo DB, Elastic 7, Solr, Cloudera Search).

./bootstrap-composer.ps1 -ComposerVersion 26.3

Install the most recent published long term support version of Self-Service Analytics. Do not start services.

./bootstrap-composer.ps1 -ComposerVersion latest-lts -SkipComposerStart