---
title: "Zetaly Installer - User Manual"
slug: "zetaly-installer"
updated: 2023-07-20T09:02:01Z
published: 2023-07-20T09:02:01Z
canonical: "docs.zetaly.io/zetaly-installer"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zetaly.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Zetaly Installer - User Manual

## Introduction

Zetaly Installer is a PowerShell script used to install the modules of your contract with Zetaly. It can be found in the Windows root directory.

![Une image contenant texte Description générée automatiquement](https://cdn.document360.io/a74c9756-0e82-4b64-bffd-236c17c00cbd/Images/Documentation/image-1649417970138.png?sv=2026-02-06&spr=https&st=2026-10-26T13%3A16%3A16Z&se=2026-10-26T14%3A16%3A16Z&sr=c&sp=r&sig=QS5aJ9x2n1rMgpFRqlXkYRYfHqRhk8bq6Ju9tabqCOg%3D)

## Prerequisites

PowerShell 7 launched in Administrator mode.

## Configuration File

By default, the configuration file `zetalyinstall.cnf` contains all the essential properties. Properties without values are to be filled. If a property is commented (i.e. when a line begins with the # character), then this property has a default value. If you need to change this property, you must uncomment it (i.e. delete the # character).

## Global Properties

See [Global Configuration Properties](/v1/docs/configuration-global).

## Commands

### Help

```powershell
.\zetalyinstall.ps1 help 
.\zetalyinstall.ps1 --help
.\zetalyinstall.ps1 help 
.\zetalyinstall.ps1 -h
.\zetalyinstall.ps1 h
```

Gives some information on the installer and possible commands.

### **All**

```powershell
.\zetalyinstall.ps1 all
```

Launches the installation of the following:

- Database-Init
- BI
- Back
- Front
- Proxy
- Zetaly Explorer

```powershell
.\zetalyinstall.ps1 all-update
```

Launches the installation of the following:

- Database-Update
- BI
- Back
- Front
- Proxy
- Zetaly Explorer

See commands below for more details.

### Create User for Database

```powershell
.\zetalyinstall.ps1 database-create-user
```

Creates a database user with privileges. The user used to create this new user must have grant privilege for the following privileges :

- MSSQL: CREATE ANY DATABASE , ALTER ANY LINKED SERVER
- PostgreSQL: Add the user in CREATEDB

The table below summarizes the configuration properties in the `zetalyinstall.cnf` file associated with creating the Zetaly database user.

| Property | Editable (Yes/No) | Description | Value(s) |
| --- | --- | --- | --- |
| `Database.Admin.UserName` | Yes | Username used to create the Zetaly user |  |
| `Database.Admin.Password` | Yes | User password |  |
| `Database.UserName` | Yes | Zetaly user to create |  |
| `Database.Password` | Yes | Zetaly user password |  |

### Database Creation

```powershell
.\zetalyinstall.ps1 database-init
```

Creates the database and launches the scripts of the required SQL elements.

The table below summarizes the configuration properties in the `zetalyinstall.cnf` file associated with creating the Zetaly database.

| Property | Editable (Yes/No) | Description | Value(s) |
| --- | --- | --- | --- |
| `Database.Type` | Yes | Type of database |  |
| `Database.Host.Base` | Yes | Address of the Zetaly database |  |
| `Database.Name` | Yes | Name of the database |  |
| `Database.UserName` | Yes | Username of the database |  |
| `Database.Password` | Yes | Password of the database |  |

### Database Update

```powershell
.\zetalyinstall.ps1 database-update
```

Checks the database version and launches the script if the Zetaly database can be upgraded.

The table below summarizes the configuration properties in the `zetalyinstall.cnf` file associated with upgrading the Zetaly database.

| Property | Editable (Yes/No) | Description | Value(s) |
| --- | --- | --- | --- |
| `Database.Type` | Yes | Type of database |  |
| `Database.Host.Base` | Yes | Address of the Zetaly database |  |
| `Database.Name` | Yes | Name of the database |  |
| `Database.UserName` | Yes | Username of the database |  |
| `Database.Password` | Yes | Password of the database |  |

### BI

```powershell
.\zetalyinstall.ps1 bi
```

Installs all the BI Tool related components:

- Installs or upgrades the core BI software
- Updates dashboards
- Updates elasticubes

The table below summarizes the configuration properties in the `zetalyinstall.cnf` file associated with installing or upgrading the BI Tool.

| Property | Editable (Yes/No) | Description | Value(s) |
| --- | --- | --- | --- |
| `BI.FileName` | No | Location of the BI Tool installer | ./Sisense*.exe |
| `BI.Version` | No | Specific version of the BI Tool | 8.2.3.10108 |
| `BI.LicenseFile` | Yes | Location of the BI Tool license file |  |
| `BI.Username` | Yes | Username of the BI Tool user |  |
| `BI.Password` | Yes | Password of the BI Tool user |  |
| `BI.Protocol` | Yes | Protocol to access BI Tool | (DEPRECATED) https only |
| `BI.HostAddress` | Yes | Address to access BI Tool | localhost *.*.*.* |
| `BI.PortNumber` | Yes | Port to access BI Tool | 8081 |
| `BI.Mail.Host` | Yes | Bi mail hostname | [BI.HostAddress] |
| `BI.Mail.Port` | Yes | Bi mail port | [BI.PortNumber] |
| `BI.Mail.User` | Yes | Bi mail username | [BI.UserName] |
| `BI.Mail.Pass` | Yes | Bi mail password | [BI.Password] |
| `BI.Mail.Timeout` | Yes | Bi mail Timeout | 999 |
| `BI.Mail.UseTls` | Yes | Use Tls | False |
| `BI.Mail.IgnoreTls` | Yes | Ignore Tls | False |
| `BI.Mail.RequireTls` | Yes | Need Tls | False |
| `BI.Mail.Logger` | Yes | Active Bi mail logs | True/False |
| `BI.Dashboards.ImportAction` | Yes | Type of action when a dashboard with the same name is already imported | - skip : The imported dashboard is skipped if existing - overwrite : The existing dashboard is overwritten - duplicate : The imported dashboard is created on the target server with a new name - none : no action is taken, dashboards will not be imported (even if they are not present) |
| `Elasticubes.ImportAction` | Yes | Action to realize when importing the new ElastiCubes | - skip - overwrite - duplicate - none (no elasticube importation even if they are not present) |
| `BI.Anonymous.Email` | Yes | Anonymous user email | anonymous@zetaly.io |
| `BI.Anonymous.Password` | Yes | Anonymous user password | password |

#### 

#### Cube Update

The command below lets you update existing cubes in the BI Tool if they exist, or create new cubes in the BI Tool if they do not yet exist. You can specify multiple cubes, separating them by spaces. Any cube specified is either updated if it exists in the BI Tool, or created if missing in the BI Tool.

```powershell
.\zetalyinstall.ps1 cube-update 'cube-name1' 'cube-name2' ...
```

Where `cube-nameN` is the name of the cube(s) you want to update or create.

Existing cubes in the BI Tool are overwrittenThis command overwrites the specified cube(s) if they exist.  
You will lose data if you already have the cube(s) installed and built.

#### Dashboard Update

The command below lets you update existing dashboards in the BI Tool if they exist, or create new dashboards in the BI Tool if they do not yet exist. You can specify multiple dashboards, separating them by spaces. Any dashboard specified is either updated if it exists in the BI Tool, or created if missing in the BI Tool.

```powershell
.\zetalyinstall.ps1 dashboard-update 'dashboard-name1' 'dashboard-name2' ...
```

Where `dashboard-nameN` is the name of the dashboard(s) you want to update or create.

Existing dashboards in the BI Tool are overwrittenThis command overwrites the specified dashboard(s). You will lose any of your personal updates made on the specified dashboard(s).

### Proxy

```powershell
.\zetalyinstall.ps1 proxy
```

Installs the NodeJS proxy used to deliver the front part and redirect all the front accesses.

If a property named "*IsActivated" for a specific module is true, you must update the other properties for this module. For example, if FrontalWeb.ZccIsActivated is true, you must update the following properties: FrontalWeb.ZccScheme, FrontalWeb.ZccUrl, FrontalWeb.ZccPort.

The table below summarizes the configuration properties in the `zetalyinstall.cnf` file associated with installing the proxy.

| Property | Editable (Yes/No) | Description | Value(s) |
| --- | --- | --- | --- |
| `FrontalWeb.TargetDir` | Yes | Location where the Zetaly Portal will be installed | `C:/zetalySuite/frontalweb` |
| `FrontalWeb.Scheme` | Yes | Protocol to access the Zetaly Portal | http https |
| `FrontalWeb.Url` | Yes | Address to access the Zetaly Portal | localhost *.*.*.* |
| `FrontalWeb.Port` | Yes | Port to access the Zetaly Portal | 443 |
| `FrontalWeb.Certif.Crt` | Yes | Certificate for https | `D:/secrets/domain.crt` |
| `FrontalWeb.Certif.Key` | Yes | Key for https certificate | `D:/secrets/domain.key` |
| `FrontalWeb.ZccIsdeployed` | Yes | If false, the ZCC module is not displayed by the Zetaly Portal | true false |
| `FrontalWeb.ZccIsActivated` | Yes | Boolean to defined if ZCC is activated | true false |
| `FrontalWeb.ZccScheme` | Yes | Protocol to access ZCC | http https |
| `FrontalWeb.ZccUrl` | Yes | Address to access ZCC | localhost *.*.*.* |
| `FrontalWeb.ZccPort` | Yes | Port to access ZCC | 5656 |
| `FrontalWeb.BiIsActivated` | Yes | Boolean to defined if BI is activated | true false |
| `FrontalWeb.BIScheme` | Yes | Protocol to access BI | http https |
| `FrontalWeb.BIUrl` | Yes | Address to access BI | localhost *.*.*.* |
| `FrontalWeb.BIPort` | Yes | Port to access BI | 8081 |
| `FrontalWeb.AscIsActivated` | Yes | Boolean to defined if ASC is activated | true false |
| `FrontalWeb.AscIsDeployed` | Yes | If false, the ZAC module is not displayed by the Zetaly Portal | true false |
| `FrontalWeb.AscScheme` | Yes | Protocol to access ASC | http https |
| `FrontalWeb.AscUrl` | Yes | Address to access ASC | localhost *.*.*.* |
| `FrontalWeb.AscPort` | Yes | Port to access ASC | 8082 |
| `FrontalWeb.ZrpIsActivated` | Yes | Boolean to defined if ZRP is activated | true false |
| `FrontalWeb.ZrpIsDeployed` | Yes | If false, the ZRP module is not displayed by the Zetaly Portal | true false |
| `FrontalWeb.ZrpScheme` | Yes | Protocol to access ZRP | http https |
| `FrontalWeb.ZrpUrl` | Yes | Address to access ZRP | localhost *.*.*.* |
| `FrontalWeb.ZrpPort` | Yes | Port to access ZRP | 8083 |
| `FrontalWeb.MyZetalyIsActivated` | Yes | Boolean to defined if MYZ is activated | true false |
| `FrontalWeb.MyZetalyIsDeployed` | Yes | If false, the MYZ module is not displayed by the Zetaly Portal | true false |
| `FrontalWeb.MyZetalyScheme` | Yes | Protocol to access MYZ | http https |
| `FrontalWeb.MyZetalyUrl` | Yes | Address to access MYZ | localhost *.*.*.* |
| `FrontalWeb.MyZetalyPort` | Yes | Port to access MYZ | 8084 |
| `FrontalWeb.ZdeIsActivated` | Yes | Boolean to defined if ZDE is activated | true false |
| `FrontalWeb.ZdeIsDeployed` | Yes | If false, the ZDE module is not displayed by the Zetaly Portal | true false |
| `FrontalWeb.ZdeScheme` | Yes | Protocol to access ZDE | http https |
| `FrontalWeb.ZdeUrl` | Yes | Address to access ZDE | localhost *.*.*.* |
| `FrontalWeb.ZdePort` | Yes | Port to access ZDE | 8085 |
| `FrontalWeb.ZsiIsDeployed` | Yes | If false, the ZDE module is not displayed by the Zetaly Portal | true false |

### Backend

```powershell
.\zetalyinstall.ps1 backend
```

Installs all the backend modules (ZCC, ZRP, MYZ, ZDE), whose configuration properties are summarized in the sub-sections below.

#### ZCC

The table below summarizes the configuration properties in the `zetalyinstall.cnf` file associated with installing the ZCC backend module.

| Property | Editable (Yes / No) | Description | Value | Product Version |
| --- | --- | --- | --- | --- |
| `Backend.ZCC.TargetDir` | Yes | Installation directory | `C:/zetalySuite/ZCC/` | S2.6 |

The ZCC database connection uses the `Database.*` properties defined in the `zetalyinstall.cnf` file and used during the database initialization or database update. For more information, see [Database Initialization](/v1/docs/zetaly-installer#database-initialization) above.

#### ZRP

The table below summarizes the configuration properties in the `zetalyinstall.cnf` file associated with installing the ZRP backend module.

| Property | Editable (Yes / No) | Description | Value | Product Version |
| --- | --- | --- | --- | --- |
| `Backend.ZRP.TargetDir` | Yes | Installation directory | `C:/zetalySuite/ZRP/` | S2.6 |
| `Backend.ZRP.Port` | Yes | ZRP backend port | 8083 | S2.6 |
| `Backend.ZRP.DB.Kind` | Yes | ZRP Database type | postgresql mssql | S2.6 |
| `Backend.ZRP.DB.Username` | Yes | ZRP Database username |  | S2.6 |
| `Backend.ZRP.DB.Password` | Yes | ZRP Database password |  | S2.6 |
| `Backend.ZRP.DB.Url` | Yes | ZRP URL for jdbc driver | PostgreSQL: jdbc:postgresql://myip/mydatabase MSSQL: jdbc:sqlserver://myip;databaseName = mydatabase | S2.6 |
| `Backend.ZRP.DB.GenerationMode` | Yes | ZRP Database generation-mode | update : Update the database structure only drop-and-create : Drop and create the database at launch. Test purpose only | S2.6 |
| `Backend.ZRP.Dino.DB.Kind` | Yes | ZetalyDB Database type |  | S2.6 |
| `Backend.ZRP.Dino.DB.Username` | Yes | ZetalyDB Database username |  | S2.6 |
| `Backend.ZRP.Dino.DB.Password` | Yes | ZetalyDB Database password |  | S2.6 |
| `Backend.ZRP.Dino.DB.Url` | Yes | ZetalyDB URL for jdbc driver | PostgreSQL: jdbc:postgresql://myip/mydatabase MSSQL: jdbc:sqlserver://myip;databaseName = mydatabase | S2.6 |
| `Backend.ZRP.replaceSmfIntervalGap` | Yes | Allows to fix the smf interval gap | REPLACE_GAP, NOTHING | S2.6-R2022-05 |
| `Backend.ZRP.maxPeriodIntervalNumber` | Yes | Max occurrence number to fix | number, recommanded value 2 | S2.6-R2022-05 |

#### MYZ

The table below summarizes the configuration properties in the `zetalyinstall.cnf` file associated with installing the MYZ backend module.

| Property | Editable (Yes / No) | Description | Value | Product Version |
| --- | --- | --- | --- | --- |
| `Backend.MYZ.TargetDir` | Yes | Installation directory | `C:/zetalySuite/MYZ/` | S2.6 |
| `Backend.MYZ.Port` | Yes | MYZ backend port | 8084 | S2.6 |
| `Backend.MYZ.DB.Kind` | Yes | MYZ Database type | postgresql mssql | S2.6 |
| `Backend.MYZ.DB.Username` | Yes | MYZ Database username |  | S2.6 |
| `Backend.MYZ.DB.Password` | Yes | MYZ Database password |  | S2.6 |
| `Backend.MYZ.DB.Url` | Yes | MYZ URL for jdbc driver | PostgreSQL: jdbc:postgresql://myip/mydatabase MSSQL: jdbc:sqlserver://myip;databaseName = mydatabase | S2.6 |
| `Backend.MYZ.DB.GenerationMode` | Yes | MYZ Database generation-mode | update : Update the database structure only drop-and-create : Drop and create the database at launch. Test purpose only | S2.6 |

#### ZDE

The table below summarizes the configuration properties in the `zetalyinstall.cnf` file associated with installing the ZDE backend module.

| Property | Editable (Yes / No) | Description | Value | Product Version |
| --- | --- | --- | --- | --- |
| `Backend.ZDE.TargetDir` | Yes | Installation directory | `C:/zetalySuite/ZDE/` | S2.6>-R2022-05 |
| `Backend.ZDE.Port` | Yes | ZDE backend port | 8084 | S2.6-R2022-05 |
| `Backend.ZDE.DB.Kind` | Yes | ZDE Database type | postgresql mssql | S2.6-R2022-05 |
| `Backend.ZDE.DB.Username` | Yes | ZDE Database username |  | S2.6-R2022-05 |
| `Backend.ZDE.DB.Password` | Yes | ZDE Database password |  | S2.6-R2022-05 |
| `Backend.ZDE.DB.Url` | Yes | ZDE URL for jdbc driver | PostgreSQL: jdbc:postgresql://myip/mydatabase MSSQL: jdbc:sqlserver://myip;databaseName = mydatabase | S2.6-R2022-05 |
| `Backend.ZDE.DB.GenerationMode` | Yes | ZDE Database generation-mode | update : Update the database structure only drop-and-create : Drop and create the database at launch. Test purpose only | S2.6-R2022-05 |

### Frontend

```powershell
.\zetalyinstall.ps1 front
```

Unzip and copy the frontend folder.

The table below summarizes the configuration property in the `zetalyinstall.cnf` file associated with installing the Frontend module.

| Property | Editable (Yes/No) | Description | Value(s) |
| --- | --- | --- | --- |
| `Frontend.TargetDir` | No | Location where the Zetaly website will be installed | /proxy/dist |

### Zetaly Explorer

```powershell
.\zetalyinstall.ps1 zex
```

Uninstall (if already installed) and install the new version of Zetaly Explorer. If the licence file is provided, it will set the license.

The table below summarizes the configuration properties in the `zetalyinstall.cnf` file associated with installing Zetaly Explorer.

| Property | Editable (Yes / No) | Description | Value(s) |
| --- | --- | --- | --- |
| `ZEX.TargetDir` | Yes | Location where Zetaly Explorer will be installed | `C:/Program Files (x86)/ZETALY Explorer` **Note:** must not be changed to avoid any errors. See the article about the [ZEX explorer](/v1/docs/zetaly-explorer). |
| `ZEX.LicenseFile` | Yes | Location of your license file |  |
| `ZEX.Mode` | Yes | Choose between Client or Server installation mode | - 1 for Client - 2 for Server |

### Back and Front

```powershell
.\zetalyinstall.ps1 BackAndFront
```

Combines the backend and frontend steps described in the [Backend](/v1/docs/zetaly-installer#backend) and [Frontend](/v1/docs/zetaly-installer#frontend) sections. See the [Backend](/v1/docs/zetaly-installer#backend) and [Frontend](/v1/docs/zetaly-installer#frontend) sections for more details.

| Property | Editable (Yes/No) | Description | Value(s) |
| --- | --- | --- | --- |
| `Database.Type` | Yes | Type of database |  |
| `Database.Host.Base` | Yes | Address of the Zetaly database |  |
| `Database.Name` | Yes | Name of the database |  |
| `Database.UserName` | Yes | Username of the database |  |
| `Database.Password` | Yes | Password of the database |  |

### Cron Update jobData for SMF-30

```none
.\zetalyinstall.ps1 cron
```

Starts the job scheduler to update "account" in the jobData table of the other SMF 30 subtypes with reference to the "account" of subtype number 1.

This job is not mandatory. See [this article](https://docs.zetaly.io/v1/docs/smf-30-accounting-field) for more details.

The table below summarizes the configuration properties in the `zetalyinstall.cnf` file associated with starting the job scheduler.

| Property | Editable (Yes/No) | Description | Value(s) |
| --- | --- | --- | --- |
| `Database.Type` | Yes | Type of database |  |
| `Database.Host.Base` | Yes | Address of the Zetaly database |  |
| `Database.Name` | Yes | Name of the database |  |
| `Database.UserName` | Yes | Username of the database |  |
| `Database.Password` | Yes | Password of the database |  |
| `CRON.SystemUser` | Yes | Name of your User System |  |
| `CRON.TargetDir` | No | Location where SQL file and batch file will be created | `C:/zetalySuite/CRONS/` |

## Troubleshooting

See the [troubleshooting page with frequently encountered problems](https://docs.zetaly.io/v1/docs/troubleshooting-installation).

### Contact Support

If you need to contact the Zetaly Support about any Zetaly Installer issues, provide the installation logs (by default in `C:\zetalySuite\zetalylogs`).