---
title: "Windows Configuration Properties"
slug: "configuration-windows"
updated: 2024-03-12T10:51:46Z
published: 2024-03-12T10:51:46Z
canonical: "docs.zetaly.io/configuration-windows"
---

> ## 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.

# Windows Configuration Properties

Note:

          

Installation on Windows is deprecated.

## Introduction

Zetaly provides a global configuration file called `zetalyinstall.cnf` which contains all the necessary properties to perform a default installation under Windows. Before running the installation script, you must define the values for the properties in the `zetalyinstall.cnf` file according to [this article](/v1/docs/configuration-global). In some cases you may need to customize to your installation to support your installation environment. Examples include, but are not limited to the following:

- needing to change the default port of one or more Zetaly modules to avoid port clashes with other services that are already using the same port,
- not installing some of the Zetaly modules if they are not delivered in the Zetaly installation package,
- changing the default log level of the Zetaly modules,
- installing the different Zetaly modules on different servers,
- configuring access to the ZAC module on the mainframe (by default the installer assumes that ZAC is not installed on the mainframe),
- configuring some modules to use different databases (by default all of the Zetaly modules use the same database),
- changing the default importation method for already existing Dashboards and ElastiCubes.

To customize your installation under Windows you must add additional properties at the end of the `zetalyinstall.cnf` file before running the installation script.

## Custom Configuration Properties

The table below summarizes the properties that you can add into the `zetalyinstall.cnf` file to customize your installation. Each line you add for a property in the `zetalyinstall.cnf` file overrides the installation script's default value with the value that you specify. Each line you add must take the following format, where the `custom.property` and `custom value` you define are seperated by an equals symbol (=).

```
custom property   =   custom value
```

Some properties can be customized individually, while other groups of properties must be customized together (as they have interdependencies). For examples of when groups of properties must be customized together, see [Customization Examples](/v1/docs/configuration-windows#customization-examples). You can also add comments using the hash symbol (#) to describe your custom installation properties.

```
############################################
#       Custom Installation Properties     #
############################################
custom.property.1  =   custom value 1
custom.property.2  =   custom value 2
custom.property.3  =   custom value 3
```

          Note:

          

The customizable properties in the table below have default values which typically do not need changing. Change them with caution. If in doubt, contact Zetaly support for more information.

| Property | Description | Default Value |
| --- | --- | --- |
| `BI.FileName` | Path to the .exe file of the BI Tool installer. Only used for the first BI installation. | `./Sisense*.exe` |
| `BI.Version` | Version of the BI Tool. | 8.2.3.10108 |
| `BI.Anonymous.Email` | Anonymous username, used to access the public dashboard. | anonymous-user@zetaly.io |
| `BI.Anonymous.Password` | Anonymous password. | Zetaly01!. |
| `BI.Mail.Host` | Address of the BI server. | By default, the installation script uses the `BI.Host.Base` value that you defined in the `zetalyinstall.cnf` file. |
| `BI.Mail.Port` | Port of the BI server. | By default, the installation script uses the `BI.Host.Port` value that you defined in the `zetalyinstall.cnf` file. |
| `BI.Mail.User` | BI System Admin e-mail. | By default, the installation script uses the `BI.UserName` value that you defined in the `zetalyinstall.cnf` file. |
| `BI.Mail.Pass` | BI System Admin password. | By default, the installation script uses the `BI.Password` value that you defined in the `zetalyinstall.cnf` file. |
| `BI.Mail.Timeout` | Defines the BI e-mail server's timeout value in milliseconds. | 999 |
| `BI.Mail.UseTls` | Determines if the connection with the BI Tool's e-mail server only uses Transport Layer Security (TLS). If true the connection will only use TLS. If false (the default), TLS may still be upgraded to if available via the STARTTLS command. | false |
| `BI.Mail.IgnoreTls` | Determines if the BI Tool's e-mail server ignores TLS requests. If this is true and BI.Mail.UseTls is false, TLS will not be used (either to connect, or as a STARTTLS connection upgrade command). | false |
| `BI.Mail.RequireTls` | Determines if the BI Tool's e-mail server requires TLS. If this is ture and BI.Mail.UseTl is false, it forces application to use STARTTLS even if the server does not advertise support for it. | false |
| `BI.Mail.Logger` | Determines if logs are activated on the BI Tool's e-mail server. Possible values: - true - false | false |
| `BI.Dashboards.ImportAction` | Type of importation method to use for already existing dashboards. Possible values: - duplicate - the imported dashboard is created on the target server with a new name. - overwrite - the existing dashboard is overwritten on the target server. - skip - the imported dashboard is skipped if it exists on the target server. - none - no action is taken. Dashboards will not be imported on the target server (even if they are not present). | overwrite |
| `Elasticubes.ImportAction` | Type of importation method to use for already existing ElastiCubes. Possible values: - overwrite - the existing ElastiCube is overwritten on the target server. - skip - the imported ElastiCube is skipped if it exists on the target server. - none - no action is taken. ElastiCubes will not be imported on the target server (even if they are not present). | skip |
| `FrontalWeb.TargetDir` | Installation directory where the Zetaly Portal will be installed. | `C:/zetalySuite/frontalweb/` |
| `Frontal.Host.Port` | Port to access the Zetaly Portal. | 443 |
| `FrontalWeb.BIScheme` | The protocol used by the BI module. Possible values: - https - http **Note:** Typically this property not added to the `zetalyinstall.cnf` file. You must always use https use for new installations or for an enviroment that already has the BI module installed and configured using https (i.e. you do not need to add this parameter). You only need to add this parameter and specify http for an enviroment that already has the BI module installed and configured to use http. | https |
| `FrontalWeb.BIUrl` | Address of the BI server. | By default, the installation script uses the BI.Host.Base value that you defined in the `zetalyinstall.cnf` file. |
| `FrontalWeb.BIPort` | Port of the BI server. | By default, the installation script uses the BI.Host.Port value that you defined in the `zetalyinstall.cnf` file. |
| `FrontalWeb.ZccIsActivated` | Determines whether the client PC's ZCC request via the Zetaly Portal is processed by the FrontalWeb Proxy or directly by the ZCC module. Possible values: - true - the ZCC request is processed by the FrontalWeb Proxy. - false - the ZCC request is not processed by the FrontalWeb Proxy. Must be set to true if you want the ZCC request to be managed by the FrontalWeb Proxy. | true |
| `FrontalWeb.ZccIsDeployed` | Determines whether the ZCC module is deployed during the installation and displayed by the Zetaly Portal. Possible values: - true - the ZCC module is installed and displayed by the Zetaly Portal. - false - the ZCC module is not installed and not displayed by the Zetaly Portal. Must be set to true if ZCC is contained in the Zetaly installation package. | true |
| `FrontalWeb.ZccScheme` | Protocol used by the FrontalWeb component to internally access the ZCC module. Possible values: - http - https **Note:** If you change the value to https you must additionally create and install an SSL certificate. Since this property defines the protocol to use internally behind the FrontalWeb component, Zetaly recommend that you leave the default setting of http. | http |
| `FrontalWeb.ZccUrl` | Address used by the FrontalWeb component to internally access the ZCC module. Possible values: - localhost - IP address of server hosting the ZCC module **Note:** By default all the Zetaly modules (including the ZCC module) are installed on the same server as the FrontalWeb component, and the default value of localhost applies. If you install the ZCC module on a different server than the one hosting the FrontalWeb component, you must change the value of this property to the IP address of the server hosting the ZCC module. | localhost |
| `FrontalWeb.ZccPort` | Port used by the FrontalWeb component to internally access the ZCC module. | 5656 |
| ` FrontalWeb.ZacIsDeployed` | Determines whether the ZAC module is displayed by the Zetaly Portal. Possible values: - true - the ZAC module is displayed by the Zetaly Portal. - false - the ZAC module is not displayed by the Zetaly Portal. **Note:** Unlike the other Zetaly modules which are installed by the Zetaly installer on the server, the ZAC module is installed separately (i.e not by the Zetaly installer) on the mainframe. For more information, see the [ZAC Installation Guide](/v1/docs/zac-44-installation-guide). Therefore, compared to the other Zetaly modules, this parameter only determines whether the ZAC module is displayed by the Zetaly portal. | false |
| `FrontalWeb.ZacScheme` | Protocol used by the FrontalWeb component to externally access the ZAC module's reporter web server hosted on the mainframe. Possible values: - http - if the reporter web server on the mainframe is configured to use the http protocol - https - if the reporter web server on the mainframe is configured to use the https protocol over TLS | http |
| `FrontalWeb.ZacUrl` | Address used by the FrontalWeb component to externally access the ZAC module's reporter web server hosted on the mainframe. Possible values: - domain name of the mainframe hosting the ZAC module - IP address of the mainframe hosting the ZAC module **Note:** By default all the Zetaly modules (except the ZAC module) are installed on the same server as the FrontalWeb component, and the default value of localhost applies. The ZAC module is always installed on the mainframe. If you use the ZAC module you must add this property to the `zetalyinstall.cnf` file, and change the value of this property to the IP address or domain name of the mainframe hosting the ZAC module. | localhost |
| `FrontalWeb.ZacPort` | Port used by the FrontalWeb component to externally access the ZAC module's reporter web server hosted on the mainframe. | 8082 |
| `FrontalWeb.ZrpIsActivated` | Determines whether the client PC's ZRP request via the Zetaly Portal is processed by the FrontalWeb Proxy or directly by the ZRP module. Possible values: - true - the ZRP request is processed by the FrontalWeb Proxy. - false - the ZRP request is not processed by the FrontalWeb Proxy. Must be set to true if you want the ZRP request to be managed by the FrontalWeb Proxy. | true |
| `FrontalWeb.ZrpIsDeployed` | Determines whether the ZRP module is deployed during the installation and displayed by the Zetaly Portal. Possible values: - true - the ZRP module is installed and displayed by the Zetaly Portal. - false - the ZRP module is not installed and not displayed by the Zetaly Portal. Must be set to true if ZRP is contained in the Zetaly installation package. | true |
| `FrontalWeb.ZrpScheme` | Protocol used by the FrontalWeb component to internally access the ZRP module. Possible values: - http - https **Note:** If you change the value to https you must additionally create and install an SSL certificate. Since this property defines the protocol to use internally behind the FrontalWeb component, Zetaly recommend that you leave the default setting of http. | http |
| `FrontalWeb.ZrpUrl` | Address used by the FrontalWeb component to internally access the ZRP module. Possible values: - localhost - IP address of server hosting the ZRP module **Note:** By default all the Zetaly modules (including the ZRP module) are installed on the same server as the FrontalWeb component, and the default value of localhost applies. If you install the ZRP module on a different server than the one hosting the FrontalWeb component, you must change the value of this property to the IP address of the server hosting the ZRP module. | localhost |
| `FrontalWeb.ZrpPort` | Port used by the FrontalWeb component to internally access the ZRP module. | 8083 |
| `FrontalWeb.MyZetalyIsActivated` | Determines whether the client PC's MYZ request via the Zetaly Portal is processed by the FrontalWeb Proxy or directly by the MYZ module. Possible values: - true - the MYZ request is processed by the FrontalWeb Proxy. - false - the MYZ request is not processed by the FrontalWeb Proxy. Must be set to true if you want the MYZ request to be managed by the FrontalWeb Proxy. | true |
| `FrontalWeb.MyZetalyIsDeployed` | Determines whether the MYZ module is deployed during the installation and displayed by the Zetaly Portal. Possible values: - true - the MYZ module is installed and displayed by the Zetaly Portal. - false - the MYZ module is not installed and not displayed by the Zetaly Portal. Must be set to true if MYZ is contained in the Zetaly installation package. | true |
| `FrontalWeb.MyZetalyScheme` | Protocol used by the FrontalWeb component to internally access the MYZ module. Possible values: - http - https **Note:** If you change the value to https you must additionally create and install an SSL certificate. Since this property defines the protocol to use internally behind the FrontalWeb component, Zetaly recommend that you leave the default setting of http. | http |
| `FrontalWeb.MyZetalyUrl` | Address used by the FrontalWeb component to internally access the MYZ module. Possible values: - localhost - IP address of server hosting the MYZ module **Note:** By default all the Zetaly modules (including the MYZ module) are installed on the same server as the FrontalWeb component, and the default value of localhost applies. If you install the MYZ module on a different server than the one hosting the FrontalWeb component, you must change the value of this property to the IP address of the server hosting the MYZ module. | localhost |
| `FrontalWeb.MyZetalyPort` | Port used by the FrontalWeb component to internally access the MYZ module. | 8084 |
| `FrontalWeb.ZdeIsActivated` | Determines whether the client PC's ZDE request via the Zetaly Portal is processed by the FrontalWeb Proxy or directly by the ZDE module. Possible values: - true - the ZDE request is processed by the FrontalWeb Proxy. - false - the ZDE request is not processed by the FrontalWeb Proxy. Must be set to true if you want the ZDE request to be managed by the FrontalWeb Proxy. | true |
| `FrontalWeb.ZdeIsDeployed` | Determines whether the ZDE module is deployed during the installation and displayed by the Zetaly Portal. Possible values: - true - the ZDE module is installed and displayed by the Zetaly Portal. - false - the ZDE module is not installed and not displayed by the Zetaly Portal. Must be set to true if ZDE is contained in the Zetaly installation package. | true |
| `FrontalWeb.ZdeScheme` | Protocol used by the FrontalWeb component to internally access the ZDE module. Possible values: - http - https **Note:** If you change the value to https you must additionally create and install an SSL certificate. Since this property defines the protocol to use internally behind the FrontalWeb component, Zetaly recommend that you leave the default setting of http. | http |
| `FrontalWeb.ZdeUrl` | Address used by the FrontalWeb component to internally access the ZDE module. Possible values: - localhost - IP address of server hosting the ZDE module **Note:** By default all the Zetaly modules (including the ZDE module) are installed on the same server as the FrontalWeb component, and the default value of localhost applies. If you install the ZDE module on a different server than the one hosting the FrontalWeb component, you must change the value of this property to the IP address of the server hosting the ZDE module. | localhost |
| `FrontalWeb.ZdePort` | Port used by the FrontalWeb component to internally access the ZDE module. | 8085 |
| `FrontalWeb.ZsaIsActivated` | Determines whether the client PC's ZSA request via the Zetaly Portal is processed by the FrontalWeb Proxy or directly by the ZSA module. Possible values: - true - the ZSA request is processed by the FrontalWeb Proxy. - false - the ZSA request is not processed by the FrontalWeb Proxy. Must be set to true if you want the ZSA request to be managed by the FrontalWeb Proxy. | true |
| `FrontalWeb.ZsaIsDeployed` | Determines whether the ZSA module is deployed during the installation and displayed by the Zetaly Portal. Possible values: - true - the ZSA module is installed and displayed by the Zetaly Portal. - false - the ZSA module is not installed and not displayed by the Zetaly Portal. Must be set to true if ZSA is contained in the Zetaly installation package. | true |
| `FrontalWeb.ZsaScheme` | Protocol used by the FrontalWeb component to internally access the ZSA module. Possible values: - http - https **Note:** If you change the value to https you must additionally create and install an SSL certificate. Since this property defines the protocol to use internally behind the FrontalWeb component, Zetaly recommend that you leave the default setting of http. | http |
| `FrontalWeb.ZsaUrl` | Address used by the FrontalWeb component to internally access the ZSA module. Possible values: - localhost - IP address of server hosting the ZSA module **Note:** By default all the Zetaly modules (including the ZSA module) are installed on the same server as the FrontalWeb component, and the default value of localhost applies. If you install the ZSA module on a different server than the one hosting the FrontalWeb component, you must change the value of this property to the IP address of the server hosting the ZSA module. | localhost |
| `FrontalWeb.ZsaPort` | Port used by the FrontalWeb component to internally access the ZSA module. | 8086 |
| `FrontalWeb.ZsacIsActivated` | Determines whether the client PC's ZSAC request via the Zetaly Portal is processed by the FrontalWeb Proxy or directly by the ZSAC module. Possible values: - true - the ZSAC request is processed by the FrontalWeb Proxy. - false - the ZCC request is not processed by the FrontalWeb Proxy. Must be set to true if you want the ZSAC request to be managed by the FrontalWeb Proxy. | true |
| `FrontalWeb.ZsacIsDeployed` | Determines whether the ZSAC module is deployed during the installation and displayed by the Zetaly Portal. Possible values: - true - the ZSAC module is installed and displayed by the Zetaly Portal. - false - the ZSAC module is not installed and not displayed by the Zetaly Portal. Must be set to true if ZSAC is contained in the Zetaly installation package. | true |
| `FrontalWeb.ZsacScheme` | Protocol used by the FrontalWeb component to internally access the ZSAC module. Possible values: - http - https **Note:** If you change the value to https you must additionally create and install an SSL certificate. Since this property defines the protocol to use internally behind the FrontalWeb component, Zetaly recommend that you leave the default setting of http. | http |
| `FrontalWeb.ZsacUrl` | Address used by the FrontalWeb component to internally access the ZSAC module. Possible values: - localhost - IP address of server hosting the ZSAC module **Note:** By default all the Zetaly modules (including the ZSAC module) are installed on the same server as the FrontalWeb component, and the default value of localhost applies. If you install the ZSAC module on a different server than the one hosting the FrontalWeb component, you must change the value of this property to the IP address of the server hosting the ZSAC module. | localhost |
| `FrontalWeb.ZsacPort` | Port used by the FrontalWeb component to internally access the ZSAC module. | 8186 |
| `FrontalWeb.ZhbIsActivated` | Determines whether the client PC's ZHB request via the Zetaly Portal is processed by the FrontalWeb Proxy or directly by the ZHB module. Possible values: - true - the ZHB request is processed by the FrontalWeb Proxy. - false - the ZHB request is not processed by the FrontalWeb Proxy. Must be set to true if you want the ZHB request to be managed by the FrontalWeb Proxy. | true |
| `FrontalWeb.ZhbIsDeployed` | Determines whether the ZHB module is deployed during the installation and displayed by the Zetaly Portal. Possible values: - true - the ZHB module is installed and displayed by the Zetaly Portal. - false - the ZHB module is not installed and not displayed by the Zetaly Portal. Must be set to true if ZHB is contained in the Zetaly installation package. | true |
| `FrontalWeb.ZhbScheme` | Protocol used by the FrontalWeb component to internally access the ZHB module. Possible values: - http - https **Note:** If you change the value to https you must additionally create and install an SSL certificate. Since this property defines the protocol to use internally behind the FrontalWeb component, Zetaly recommend that you leave the default setting of http. | http |
| `FrontalWeb.ZhbUrl` | Address used by the FrontalWeb component to internally access the ZHB module. Possible values: - localhost - IP address of server hosting the ZHB module **Note:** By default all the Zetaly modules (including the ZHB module) are installed on the same server as the FrontalWeb component, and the default value of localhost applies. If you install the ZHB module on a different server than the one hosting the FrontalWeb component, you must change the value of this property to the IP address of the server hosting the ZHB module. | localhost |
| `FrontalWeb.ZhbPort` | Port used by the FrontalWeb component to internally access the ZHB module. | 8087 |
| `FrontalWeb.ZupIsActivated` | Determines whether the client PC's ZUP request via the Zetaly Portal is processed by the FrontalWeb Proxy or directly by the ZUP module. Possible values: - true - the ZUP request is processed by the FrontalWeb Proxy. - false - the ZUP request is not processed by the FrontalWeb Proxy. Must be set to true if you want the ZUP request to be managed by the FrontalWeb Proxy. | true |
| `FrontalWeb.ZupIsDeployed` | Determines whether the ZUP module is deployed during the installation and displayed by the Zetaly Portal. Possible values: - true - the ZUP module is installed and displayed by the Zetaly Portal. - false - the ZUP module is not installed and not displayed by the Zetaly Portal. Must be set to true if ZUP is contained in the Zetaly installation package. | true |
| `FrontalWeb.ZupScheme` | Protocol used by the FrontalWeb component to internally access the ZUP module. Possible values: - http - https **Note:** If you change the value to https you must additionally create and install an SSL certificate. Since this property defines the protocol to use internally behind the FrontalWeb component, Zetaly recommend that you leave the default setting of http. | http |
| `FrontalWeb.ZupUrl` | Address used by the FrontalWeb component to internally access the ZUP module. Possible values: - localhost - IP address of server hosting the ZUP module **Note:** By default all the Zetaly modules (including the ZUP module) are installed on the same server as the FrontalWeb component, and the default value of localhost applies. If you install the ZUP module on a different server than the one hosting the FrontalWeb component, you must change the value of this property to the IP address of the server hosting the ZUP module. | localhost |
| `FrontalWeb.ZupPort` | Port used by the FrontalWeb component to internally access the ZUP module. | 8088 |
| `FrontalWeb.ZqmIsActivated` | Determines whether the client PC's ZQM request via the Zetaly Portal is processed by the FrontalWeb Proxy or directly by the ZQM module. Possible values: - true - the ZQM request is processed by the FrontalWeb Proxy. - false - the ZQM request is not processed by the FrontalWeb Proxy. Must be set to true if you want the ZQM request to be managed by the FrontalWeb Proxy. | true |
| `FrontalWeb.ZqmIsDeployed` | Determines whether the ZQM module is deployed during the installation and displayed by the Zetaly Portal. Possible values: - true - the ZQM module is installed and displayed by the Zetaly Portal. - false - the ZQM module is not installed and not displayed by the Zetaly Portal. Must be set to true if ZQM is contained in the Zetaly installation package. | true |
| `FrontalWeb.ZqmScheme` | Protocol used by the FrontalWeb component to internally access the ZQM module. Possible values: - http - https **Note:** If you change the value to https you must additionally create and install an SSL certificate. Since this property defines the protocol to use internally behind the FrontalWeb component, Zetaly recommend that you leave the default setting of http. | http |
| `FrontalWeb.ZqmUrl` | Address used by the FrontalWeb component to internally access the ZQM module. Possible values: - localhost - IP address of server hosting the ZQM module **Note:** By default all the Zetaly modules (including the ZQM module) are installed on the same server as the FrontalWeb component, and the default value of localhost applies. If you install the ZQM module on a different server than the one hosting the FrontalWeb component, you must change the value of this property to the IP address of the server hosting the ZQM module. | localhost |
| `FrontalWeb.ZqmPort` | Port used by the FrontalWeb component to internally access the ZQM module. | 8091 |
| `FrontalWeb.BiIsDeployed` | Determines whether the ZSI module is deployed during the installation. Possible values: - true - the ZSI module is displayed by the Zetaly Portal. - false - the ZSI module is not displayed by the Zetaly Portal. Must be set to true if ZSI is contained in the package. | true |
| `Frontend.TargetDir` | Installation directory where the Zetaly Portal will be installed. | `C:/zetalySuite/zetaly/` |
| `Backend.ZCC.TargetDir` | Installation directory where the ZCC module will be installed. | `C:/zetalySuite/ZCC/` |
| `Backend.ZCC.LogLevel` | Log level for the ZCC module. Possible values (case sensitive): - Debug - Information - Warning - Error | Warning |
| `Backend.ZSA.TargetDir` | Installation directory where the ZSA module will be installed. | `C:/zetalySuite/ZSA/` |
| `Backend.ZSA.configurationType` | Name of the configuration type for SMF. | SMF |
| `Backend.ZSA.LogLevel` | Log level for the ZSA module. Possible values (case sensitive): - Debug - Information - Warning - Error | Warning |
| `Backend.ZRP.TargetDir` | Installation directory where the ZRP module will be installed. | `C:/zetalySuite/ZRP/` |
| `Backend.ZRP.LogLevel` | Log level for the ZRP module. Possible values: - OFF - FATAL - ERROR - WARN - INFO - DEBUG - TRACE - ALL | INFO |
| `Backend.ZRP.replaceSmfIntervalGap` | Mode if ZRP should fill the gap between two data intervals. Possible values: - REPLACE_GAP - NOTHING | REPLACE_GAP |
| `Backend.ZRP.DB.Kind` | Database type used by the ZRP module. Possible values: - postgresql - if your database type is PostgreSQL - mssql if your database type is MSSQL | By default, the installation script uses the Database.Type value that you defined in the `zetalyinstall.cnf` file for all Zetaly modules. If you want the ZRP module to use another database, specify the database type to use. |
| `Backend.ZRP.DB.Username` | Database user used by the ZRP module. | By default, the installation script uses the Database.UserName value that you defined in the `zetalyinstall.cnf` file for all Zetaly modules. If you want the ZRP module to use another database, specify a database user. |
| `Backend.ZRP.DB.Password` | ZRP module database user's password. | By default, the installation script uses the Database.Password value that you defined in the `zetalyinstall.cnf` file for all Zetaly modules. If you want the ZRP module to use another database, specify a password for the ZRP module database user. |
| `Backend.ZRP.DB.HostAddress` | Database host address used by the ZRP module. Can be an IP address or a domain name. | By default, the installation script uses the Database.Host.Base value that you defined in the `zetalyinstall.cnf` file for all Zetaly modules. If you want the ZRP module to use another database, specify a database host address for the ZRP module. |
| `Backend.ZRP.DB.Name` | Name of the database used by the ZRP module. | By default, the installation script uses the Database.Name value that you defined in the `zetalyinstall.cnf` file for all Zetaly modules. If you want the ZRP module to use another database, specify a database name for the ZRP module. |
| `Backend.ZRP.DB.GenerationMode` | Generation mode for the internal database. Possible values: - update (Update the database structure only, default) - drop-and-create (Drop and create the database at launch. Test purpose only) | update |
| `Backend.ZRP.Zetaly.DB.Kind` | Database type used by the ZRP module. Possible values: - postgresql - if your database type is PostgreSQL - mssql if your database type is MSSQL | By default, the installation script uses the Database.Type value that you defined in the `zetalyinstall.cnf` file for all Zetaly modules. If you want the ZRP module to use another database, specify the database type to use. |
| `Backend.ZRP.Zetaly.DB.Username` | Database user used by the ZRP module. | By default, the installation script uses the Database.UserName value that you defined in the `zetalyinstall.cnf` file for all Zetaly modules. If you want the ZRP module to use another database, specify a database user. |
| `Backend.ZRP.Zetaly.DB.Password` | ZRP module database user's password. | By default, the installation script uses the Database.Password value that you defined in the `zetalyinstall.cnf` file for all Zetaly modules. If you want the ZRP module to use another database, specify a password for the ZRP module database user. |
| `Backend.ZRP.Zetaly.DB.HostAddress` | Database host address used by the ZRP module. Can be an IP address or a domain name. | By default, the installation script uses the Database.Host.Base value that you defined in the `zetalyinstall.cnf` file for all Zetaly modules. If you want the ZRP module to use another database, specify a database host address for the ZRP module. |
| `Backend.ZRP.Zetaly.DB.Name` | Name of the database used by the ZRP module. | By default, the installation script uses the Database.Name value that you defined in the `zetalyinstall.cnf` file for all Zetaly modules. If you want the ZRP module to use another database, specify a database name for the ZRP module. |
| `Backend.MYZ.TargetDir` | Installation directory where the MYZ module will be installed. | `C:/zetalySuite/MYZ/` |
| `Backend.MYZ.LogLevel` | Log level for the MYZ module. Possible values: - OFF - FATAL - ERROR - WARN - INFO - DEBUG - TRACE - ALL | INFO |
| `Backend.MYZ.DB.Kind` | Database type used by the MYZ module. Possible values: - postgresql - if your database type is PostgreSQL - mssql if your database type is MSSQL | By default, the installation script uses the Database.Type value that you defined in the `zetalyinstall.cnf` file for all Zetaly modules. If you want the MYZ module to use another database, specify the database type to use. |
| `Backend.MYZ.DB.Username` | Database user used by the MYZ module. | By default, the installation script uses the Database.UserName value that you defined in the `zetalyinstall.cnf` file for all Zetaly modules. If you want the MYZ module to use another database, specify a database user. |
| `Backend.MYZ.DB.Password` | MYZ module database user's password. | By default, the installation script uses the Database.Password value that you defined in the `zetalyinstall.cnf` file for all Zetaly modules. If you want the MYZ module to use another database, specify a password for the MYZ module database user. |
| `Backend.MYZ.DB.HostAddress` | Database host address used by the MYZ module. Can be an IP address or a domain name. | By default, the installation script uses the Database.Host.Base value that you defined in the `zetalyinstall.cnf` file for all Zetaly modules. If you want the MYZ module to use another database, specify a database host address for the MYZ module. |
| `Backend.MYZ.DB.Name` | Name of the database used by the MYZ module. | By default, the installation script uses the Database.Name value that you defined in the `zetalyinstall.cnf` file for all Zetaly modules. If you want the MYZ module to use another database, specify a database name for the MYZ module. |
| `Backend.MYZ.DB.GenerationMode` | Generation mode for the internal database. Possible values: - update (Update the database structure only, default) - drop-and-create (Drop and create the database at launch. Test purpose only) | update |
| `Backend.ZDE.TargetDir` | Installation directory where the ZDE module is installed. | `C:/zetalySuite/ZDE/` |
| `Backend.ZDE.LogLevel` | Log level for the ZDE module. Possible values: - OFF - FATAL - ERROR - WARN - INFO - DEBUG - TRACE - ALL | INFO |
| `Backend.ZDE.DB.Kind` | Database type used by the ZDE module. Possible values: - postgresql - if your database type is PostgreSQL - mssql if your database type is MSSQL | By default, the installation script uses the Database.Type value that you defined in the `zetalyinstall.cnf` file for all Zetaly modules. If you want the ZDE module to use another database, specify the database type to use. |
| `Backend.ZDE.DB.Username` | Database user used by the ZDE module. | By default, the installation script uses the Database.UserName value that you defined in the `zetalyinstall.cnf` file for all Zetaly modules. If you want the ZDE module to use another database, specify a database user. |
| `Backend.ZDE.DB.Password` | ZDE module database user's password. | By default, the installation script uses the Database.Password value that you defined in the `zetalyinstall.cnf` file for all Zetaly modules. If you want the ZDE module to use another database, specify a password for the ZDE module database user. |
| `Backend.ZDE.DB.HostAddress` | Database host address used by the ZDE module. Can be an IP address or a domain name. | By default, the installation script uses the Database.Host.Base value that you defined in the `zetalyinstall.cnf` file for all Zetaly modules. If you want the ZDE module to use another database, specify a database host address for the ZDE module. |
| `Backend.ZDE.DB.Name` | Name of the database used by the ZDE module. | By default, the installation script uses the Database.Name value that you defined in the `zetalyinstall.cnf` file for all Zetaly modules. If you want the ZDE module to use another database, specify a database name for the ZDE module. |
| `Backend.ZDE.DB.GenerationMode` | Generation mode for the internal database. Possible values: - update (Update the database structure only, default) - drop-and-create (Drop and create the database at launch. Test purpose only) | update |
| `Backend.ZHB.TargetDir` | Installation directory where the ZHB module will be installed. | `C:/zetalySuite/ZHB/` |
| `Backend.ZHB.LogLevel` | Log level for the ZHB module. Possible values: - OFF - FATAL - ERROR - WARN - INFO - DEBUG - TRACE - ALL | INFO |
| `Backend.ZHB.DB.Kind` | Database type used by the ZHB module. Possible values: - postgresql - if your database type is PostgreSQL - mssql if your database type is MSSQL | By default, the installation script uses the Database.Type value that you defined in the `zetalyinstall.cnf` file for all Zetaly modules. If you want the ZHB module to use another database, specify the database type to use. |
| `Backend.ZHB.DB.Username` | Database user used by the ZHB module. | By default, the installation script uses the Database.UserName value that you defined in the `zetalyinstall.cnf` file for all Zetaly modules. If you want the ZHB module to use another database, specify a database user. |
| `Backend.ZHB.DB.Password` | ZHB module database user's password. | By default, the installation script uses the Database.Password value that you defined in the `zetalyinstall.cnf` file for all Zetaly modules. If you want the ZHB module to use another database, specify a password for the ZHB module database user. |
| `Backend.ZHB.DB.HostAddress` | Database host address used by the ZHB module. Can be an IP address or a domain name. | By default, the installation script uses the Database.Host.Base value that you defined in the `zetalyinstall.cnf` file for all Zetaly modules. If you want the ZHB module to use another database, specify a database host address for the ZHB module. |
| `Backend.ZHB.DB.Name` | Name of the database used by the ZHB module. | By default, the installation script uses the Database.Name value that you defined in the `zetalyinstall.cnf` file for all Zetaly modules. If you want the ZHB module to use another database, specify a database name for the ZHB module. |
| `Backend.ZHB.DB.GenerationMode` | Generation mode for the internal database. Possible values: - update (Update the database structure only, default) - drop-and-create (Drop and create the database at launch. Test purpose only) | update |
| `Backend.ZHB.Users.ZSA.Email` | ZSA username. This user is only used to communicate between ZSA and other Zetaly modules. | zsa-user@zetaly.io |
| `Backend.ZHB.Users.ZSA.Password` | ZSA password | Zetaly01!. |
| `Backend.ZHB.Users.ZUP.Email` | ZUP username. This user is only used to communicate between ZUP and other zetaly modules | zup-user@zetaly.io |
| `Backend.ZHB.Users.ZUP.Password` | ZUP password | Zetaly01!. |
| `Backend.ZUP.TargetDir` | Installation directory where the ZUP module will be installed. | `C:/zetalySuite/ZUP/` |
| `Backend.ZUP.LogLevel` | Log level for the ZUP module. Possible values: - OFF - FATAL - ERROR - WARN - INFO - DEBUG - TRACE - ALL | INFO |
| `Backend.ZUP.DB.Kind` | Database type used by the ZUP module. Possible values: - postgresql - if your database type is PostgreSQL - mssql if your database type is MSSQL | By default, the installation script uses the Database.Type value that you defined in the `zetalyinstall.cnf` file for all Zetaly modules. If you want the ZUP module to use another database, specify the database type to use. |
| `Backend.ZUP.DB.Username` | Database user used by the ZUP module. | By default, the installation script uses the Database.UserName value that you defined in the `zetalyinstall.cnf` file for all Zetaly modules. If you want the ZUP module to use another database, specify a database user. |
| `Backend.ZUP.DB.Password` | ZUP module database user's password. | By default, the installation script uses the Database.Password value that you defined in the `zetalyinstall.cnf` file for all Zetaly modules. If you want the ZUP module to use another database, specify a password for the ZUP module database user. |
| `Backend.ZUP.DB.HostAddress` | Database host address used by the ZUP module. Can be an IP address or a domain name. | By default, the installation script uses the Database.Host.Base value that you defined in the `zetalyinstall.cnf` file for all Zetaly modules. If you want the ZUP module to use another database, specify a database host address for the ZUP module. |
| `Backend.ZUP.DB.Name` | Name of the database used by the ZUP module. | By default, the installation script uses the Database.Name value that you defined in the `zetalyinstall.cnf` file for all Zetaly modules. If you want the ZUP module to use another database, specify a database name for the ZUP module. |
| `Backend.ZUP.DB.GenerationMode` | Generation mode for the internal database. Possible values: - update (Update the database structure only, default) - drop-and-create (Drop and create the database at launch. Test purpose only) | update |
| `Backend.ZQM.TargetDir` | Installation directory where the ZQM module will be installed. | `C:/zetalySuite/ZQM/` |
| `Backend.ZQM.LogLevel` | Log level for the ZQM module. Possible values: - OFF - FATAL - ERROR - WARN - INFO - DEBUG - TRACE - ALL | INFO |
| `Backend.ZQM.DB.Kind` | Database type used by the ZQM module. Possible values: - postgresql - if your database type is PostgreSQL - mssql if your database type is MSSQL | By default, the installation script uses the Database.Type value that you defined in the `zetalyinstall.cnf` file for all Zetaly modules. If you want the ZQM module to use another database, specify the database type to use. |
| `Backend.ZQM.DB.Username` | Database user used by the ZQM module. | By default, the installation script uses the Database.UserName value that you defined in the `zetalyinstall.cnf` file for all Zetaly modules. If you want the ZQM module to use another database, specify a database user. |
| `Backend.ZQM.DB.Password` | ZQM module database user's password. | By default, the installation script uses the Database.Password value that you defined in the `zetalyinstall.cnf` file for all Zetaly modules. If you want the ZQM module to use another database, specify a password for the ZQM module database user. |
| `Backend.ZQM.DB.HostAddress` | Database host address used by the ZQM module. Can be an IP address or a domain name. | By default, the installation script uses the Database.Host.Base value that you defined in the `zetalyinstall.cnf` file for all Zetaly modules. If you want the ZQM module to use another database, specify a database host address for the ZQM module. |
| `Backend.ZQM.DB.Name` | Name of the database used by the ZQM module. | By default, the installation script uses the Database.Name value that you defined in the `zetalyinstall.cnf` file for all Zetaly modules. If you want the ZQM module to use another database, specify a database name for the ZQM module. |
| `Backend.ZQM.DB.GenerationMode` | Generation mode for the internal database. Possible values: - update (Update the database structure only, default) - drop-and-create (Drop and create the database at launch. Test purpose only) | update |
| `Backend.ZSAC.TargetDir` | Installation directory where the ZSAC module will be installed. | `C:/zetalySuite/ZSAC/` |
| `Backend.ZSAC.LogLevel` | Log level for the ZSAC module. Possible values (case sensitive): - Debug - Information - Warning - Error | Warning |
| `ZEX.TargetDir` | Installation directory where the ZEX module will be installed. | `C:/Program Files (x86)/ZETALY Explorer` |
| `ZEX.LicenseFile` | Filename of the ZEX module license file. **Note:** The ZEX module license file must be located in the same directory defined by the ZEX.TargetDir property. | License.xml |
| `ZEX.Mode` | The Zetaly Explorer installation mode. Possible values: 1. Client 2. Server | 2 |
| `CRON.TargetDir` | Location where SQL file and batch file will be created. | `C:/zetalySuite/CRONS/` |
| `CRON.SystemUser` | Name of your User System. | systemUser |
| `Database.Scripts.Directory` | Folder which contains the database scripts. | .\scripts-temp\scripts |
| `Database.Host.Port` | May be used when database is to be accessed with a non-default port. | .\scripts-temp\scripts |

## Customization Examples

This section describes some examples of adding additional properties at the end of the `zetalyinstall.cnf` file for different customization scenarios.

### Resolving Port Clashes With Zetaly Modules

The table below summarizes the default port numbers and their associated properties for each of the Zetaly modules.

| Zetaly Module | Property | Default Port Number |
| --- | --- | --- |
| ZCC | `FrontalWeb.ZccPort` | 5656 |
| ZAC | `FrontalWeb.ZacPort` | 8082 |
| ZRP | `FrontalWeb.ZrpPort` | 8083 |
| MYZ | `FrontalWeb.MyZetalyPort` | 8084 |
| ZDE | `FrontalWeb.ZdePort` | 8085 |
| ZSA | `FrontalWeb.ZsaPort` | 8086 |
| ZSAC | `FrontalWeb.ZsacPort` | 8186 |
| ZHB | `FrontalWeb.ZhbPort` | 8087 |
| ZUP | `FrontalWeb.ZupPort` | 8088 |
| ZQM | `FrontalWeb.ZqmPort` | 8091 |

          Note:

          

In the table above the `FrontalWeb.ZacPort` property is listed for informational purposes, and cannot internally clash with the port 8082 on the server. This is because it is for the ZAC reporter web server which is installed on the mainframe. When the ZAC module is installed in your environment, you must configure all the ZAC related properties together according to [Configuring Access to the ZAC Module](/v1/docs/configuration-windows#configuring-access-to-the-zac-module).

In our example, the server that will have Zetaly installed has services already using ports 8086 and 8087. By default the ZSA module also uses port 8086. To avoid a port clash between the ZSA module and the other service using port 8086, you must change the ZSA module to another unused port (for example 8093). By default the ZHB module also uses port 8087. To avoid a port clash between the ZHB module and the other service using port 8087, you must change the ZHB module to another unused port (for example 8094). In this case you would create the following section at the end of the `zetalyinstall.cnf` file.

```
#################################################################
#     Custom ports for Zetaly modules to avoid port clashes     #
#################################################################
FrontalWeb.ZsaPort              =       8093
FrontalWeb.ZhbPort              =       8094
```

### Removing Undelivered Zetaly Modules

Depending on your contract, the Zetaly installation package may be delivered with not all the Zetaly modules. In this case you must add a custom property for each of the Zetaly modules that are not delivered in the Zetaly installation package. The table below summarizes the the properties for each of the Zetaly modules and whether it is always delivered.

| Zetaly Module | Property | Always Delivered |
| --- | --- | --- |
| ZCC | `FrontalWeb.ZccIsDeployed` | No |
| ZAC (see note) | `FrontalWeb.ZacIsDeployed` | No |
| ZRP | `FrontalWeb.ZrpIsDeployed` | No |
| MYZ | `FrontalWeb.MyZetalyIsDeployed` | Yes |
| ZDE | `FrontalWeb.ZdeIsDeployed` | No |
| ZSA | `FrontalWeb.ZsaIsDeployed` | Yes |
| ZSAC | `FrontalWeb.ZsacIsDeployed` | No |
| ZHB | `FrontalWeb.ZhbIsDeployed` | Yes |
| ZUP | `FrontalWeb.ZupIsDeployed` | No |
| ZQM | `FrontalWeb.ZqmIsDeployed` | No |

          Note:

          

Unlike the other Zetaly modules which are installed by the Zetaly installer on the server, the ZAC module is installed separately (i.e not by the Zetaly installer) on the mainframe. For more information, see the [ZAC Installation Guide](/v1/docs/zac-44-installation-guide). Therefore, compared to the other Zetaly modules, this parameter only determines whether the ZAC module is displayed by the Zetaly Portal.

In our example the Zetaly installation package is delivered without the ZDE and ZRP modules, and the ZAC module has not been separately installed on the mainframe. In this case you would create the following section at the end of the `zetalyinstall.cnf` file.

```
############################################################
#                Uninstalled Zetaly Modules                #
############################################################
FrontalWeb.ZdeIsDeployed               =      false
FrontalWeb.ZrpIsDeployed               =      false
```

          Note:

          

By default the installer script assumes that the ZAC module is not installed (i.e. `FrontalWeb.ZacIsDeployed = false`). Therefore, in the example above the `zetalyinstall.cnf` file does not need the line `FrontalWeb.ZacIsDeployed = false`). When the ZAC module is installed in your environment, you must configure all the ZAC related properties together according to [Configuring Access to the ZAC Module](/v1/docs/configuration-windows#configuring-access-to-the-zac-module).

### Changing the Default Log Level of the Zetaly Modules

The table below summarizes the default log levels, possible log levels and their associated properties for each of the Zetaly modules.

| Zetaly Module | Property | Default Log Level | Possible Log Levels |
| --- | --- | --- | --- |
| ZRP | `Backend.ZRP.LogLevel` | INFO | OFF, FATAL, ERROR, WARN, INFO, DEBUG, TRACE, ALL |
| MYZ | `Backend.MYZ.LogLevel` | INFO | OFF, FATAL, ERROR, WARN, INFO, DEBUG, TRACE, ALL |
| ZDE | `Backend.ZDE.LogLevel` | INFO | OFF, FATAL, ERROR, WARN, INFO, DEBUG, TRACE, ALL |
| ZHB | `Backend.ZHB.LogLevel` | INFO | OFF, FATAL, ERROR, WARN, INFO, DEBUG, TRACE, ALL |
| ZUP | `Backend.ZUP.LogLevel` | INFO | OFF, FATAL, ERROR, WARN, INFO, DEBUG, TRACE, ALL |
| ZQM | `Backend.ZQM.LogLevel` | INFO | OFF, FATAL, ERROR, WARN, INFO, DEBUG, TRACE, ALL |
| ZCO | `Backend.ZCO.LogLevel` | INFO | OFF, FATAL, ERROR, WARN, INFO, DEBUG, TRACE, ALL |
| ZCC | `Backend.ZCC.LogLevel` | Warning | Debug, Information, Warning, Error |
| ZSA | `Backend.ZSA.LogLevel` | Warning | Debug, Information, Warning, Error |
| ZSAC | `Backend.ZSAC.LogLevel` | Warning | Debug, Information, Warning, Error |

In our example we want to change the default log levels of the ZHB, ZUP and ZQM modules from INFO to WARN. In this case you would create the following section at the end of the `zetalyinstall.cnf` file.

```
############################################################
#                     Custom Log Levels                    #
############################################################
Backend.ZHB.LogLevel              =      WARN
Backend.ZUP.LogLevel              =      WARN
Backend.ZQM.LogLevel              =      WARN
```

### Configuring Zetaly Module Addresses for the FrontalWeb Component in a Distributed Deployment

By default all the Zetaly modules (except the ZAC module) are installed on the same server. As a result, the address used by the FrontalWeb component to internally access the each of the Zetaly modules is set to localhost as summarized in the table below.

| Zetaly Module | Property | Default Address |
| --- | --- | --- |
| ZCC | `FrontalWeb.ZccUrl` | localhost |
| ZRP | `FrontalWeb.ZrpUrl` | localhost |
| MYZ | `FrontalWeb.MyZetalyUrl` | localhost |
| ZDE | `FrontalWeb.ZdeUrl` | localhost |
| ZSA | `FrontalWeb.ZsaUrl` | localhost |
| ZSAC | `FrontalWeb.ZsacUrl` | localhost |
| ZHB | `FrontalWeb.ZhbUrl` | localhost |
| ZUP | `FrontalWeb.ZupUrl` | localhost |
| ZQM | `FrontalWeb.ZqmUrl` | localhost |

          Note:

          

In the table above it is normal that the parameter for the ZAC module (FrontalWeb.ZacUrl) is not listed. This is because ZAC is installed on the mainframe and not always installed. If you install ZAC in your environment, then add all the related ZAC properties to the `zetalyinstall.cnf` file in a dedicated section according to [Configuring Access to the ZAC Module](/v1/docs/configuration-windows#configuring-access-to-the-zac-module).

If you want to install the Zetaly modules on different servers, you must update these properties to match the IP addresses of the servers on which they are installed. In our example, the Zetaly modules are installed on three different servers as summarized in the table below.

| Zetaly Module | Server 1 10.0.0.1 | Server 2 10.0.0.2 | Server 3 10.0.0.3 |
| --- | --- | --- | --- |
| ZCC | Installed | Not Installed | Not Installed |
| ZRP | Not Installed | Installed | Not Installed |
| MYZ | Installed | Not Installed | Not Installed |
| ZDE | Installed | Not Installed | Not Installed |
| ZSA | Not Installed | Not Installed | Installed |
| ZSAC | Installed | Not Installed | Not Installed |
| ZHB | Installed | Not Installed | Not Installed |
| ZUP | Installed | Not Installed | Not Installed |
| ZQM | Installed | Not Installed | Not Installed |

          Note:

          

The ZSA and ZRP modules consume more RAM than the other modules. For this reason, in our example, the ZRP module is installed on Server 2 (10.0.0.2) and the ZSA module is installed on Server 3 (10.0.0.3).

In this case you would create the following section at the end of the `zetalyinstall.cnf` file.

```
############################################################
#                Distributed Module Addresses              #
############################################################
FrontalWeb.ZccUrl              =      10.0.0.1
FrontalWeb.ZrpUrl              =      10.0.0.2
FrontalWeb.MyZetalyUrl         =      10.0.0.1
FrontalWeb.ZdeUrl              =      10.0.0.1
FrontalWeb.ZsaUrl              =      10.0.0.3
FrontalWeb.ZsacUrl             =      10.0.0.1
FrontalWeb.ZhbUrl              =      10.0.0.1
FrontalWeb.ZupUrl              =      10.0.0.1
FrontalWeb.ZqmUrl              =      10.0.0.1
```

### Configuring Access to the ZAC Module

Unlike the other Zetaly modules which are installed by the Zetaly installer on the server, the ZAC module is installed separately (i.e not by the Zetaly installer) on the mainframe. If you are using the ZAC module, it will have been installed on the mainframe according to [ZAC Installation Guide](/v1/docs/zac-44-installation-guide). The following table summarizes the default values for the ZAC related properties used by the installation script.

| ZAC Related Property | Description | Default Value |
| --- | --- | --- |
| `FrontalWeb.ZacIsDeployed` | Determines whether the ZAC module is displayed by the Zetaly Portal. Possible values: - true - the ZAC module is displayed by the Zetaly Portal. - false - the ZAC module is not displayed by the Zetaly Portal. | false |
| `FrontalWeb.ZacScheme` | Protocol used by the FrontalWeb component to externally access the ZAC module's reporter web server hosted on the mainframe. Possible values: - http - if the reporter web server on the mainframe is configured to use the http protocol - https - if the reporter web server on the mainframe is configured to use the https protocol over TLS | http |
| `FrontalWeb.ZacUrl` | Address used by the FrontalWeb component to externally access the ZAC module's reporter web server hosted on the mainframe. Possible values: - domain name of the mainframe hosting the ZAC module - IP address of the mainframe hosting the ZAC module | localhost |
| `FrontalWeb.ZacPort` | Port used by the FrontalWeb component to externally access the ZAC module's reporter web server hosted on the mainframe. | 8082 |

By default these properties assume that ZAC is not installed on the mainframe. If you are using the ZAC module you must add these properties at the end of the `zetalyinstall.cnf` file and modify them according to the mainframe configuration of the ZAC module's reporter web server. For example, if the mainframe has an IP address of 10.0.0.50 and the reporter webserver is using port 2413 with the https protocol over TLS, you would create the following section at the end of the `zetalyinstall.cnf` file.

```
###############################################################
#   Enabling and accessing the ZAC module on the mainframe    #
###############################################################
FrontalWeb.ZacIsDeployed      =      true
FrontalWeb.ZacScheme          =      https
FrontalWeb.ZacUrl             =      10.0.0.50
FrontalWeb.ZacPort            =      2413
```

### Configuring the Zetaly Modules to use Different Databases

By default the installation script configures all of the Zetaly modules to use the same database using the following properties that you have defined in `zetalyinstall.cnf` file:

- `Database.Type`
- `Database.Host.Base`
- `Database.UserName`
- `Database.Password`
- `Database.Name`

You can override this default behavior, and define a separate database for one or more of the Zetaly modules. The tables below summarize the database related properties for each of the Zetaly modules, which you can use if you want to define a separate database for any of the Zetaly modules.

**ZRP Related Database Properties**

| Property | Description | Default Value |
| --- | --- | --- |
| `Backend.ZRP.DB.Kind` | Database type used by the ZRP module. Possible values: - postgresql - if your database type is PostgreSQL - mssql if your database type is MSSQL | The `Database.Type` value that you defined in the `zetalyinstall.cnf` file. |
| `Backend.ZRP.DB.Username` | Database user used by the ZRP module. | The `Database.UserName` value that you defined in the `zetalyinstall.cnf` file. |
| `Backend.ZRP.DB.Password` | ZRP module database user's password. | The `Database.Password` value that you defined in the `zetalyinstall.cnf` file. |
| `Backend.ZRP.DB.HostAddress` | Database host address used by the ZRP module. Can be an IP address or a domain name. | The `Database.Host.Base value that you defined in the zetalyinstall.cnf file.` |
| `Backend.ZRP.DB.Name` | Name of the database used by the ZRP module. | The `Database.Name` value that you defined in the `zetalyinstall.cnf` file. |
| `Backend.ZRP.DB.GenerationMode` | Generation mode for the ZRP module's internal database. Possible values: - update (Update the database structure only, default) - drop-and-create (Drop and create the database at launch. Test purpose only) | update |
| `Backend.ZRP.Zetaly.DB.Kind` | Database type used by the ZRP module. Possible values: - postgresql - if your database type is PostgreSQL - mssql if your database type is MSSQL | The `Database.Type` value that you defined in the `zetalyinstall.cnf` file. |
| `Backend.ZRP.Zetaly.DB.Username` | Database user used by the ZRP module. | The `Database.UserName` value that you defined in the `zetalyinstall.cnf` file. |
| `Backend.ZRP.Zetaly.DB.Password` | ZRP module database user's password. | The `Database.Password` value that you defined in the `zetalyinstall.cnf` file. |
| `Backend.ZRP.Zetaly.DB.HostAddress` | Database host address used by the ZRP module. Can be an IP address or a domain name. | The `Database.Host.Zetaly.Base` value that you defined in the `zetalyinstall.cnf` file. |
| `Backend.ZRP.Zetaly.DB.Name` | Name of the database used by the ZRP module. | The `Database.Name` value that you defined in the `zetalyinstall.cnf` file. |

          Note:

          

The ZRP module uses two databases. The first database (which configured using the `Backend.ZRP.DB.* ` properties) uses read-write mode, and a `Backend.ZRP.DB.GenerationMode` property exists as the ZRP module collects and updates data from this database. The second database (which configured using the `Backend.ZRP.Zetaly.DB.*` properties) uses read-only mode, and a `Backend.ZRP.Zetaly.DB.GenerationMode` property intentionally does not exist as the ZRP module only collects data from this database.

**MYZ Related Database Properties**

| Property | Description | Default Value |
| --- | --- | --- |
| `Backend.MYZ.DB.Kind` | Database type used by the MYZ module. Possible values: - postgresql - if your database type is PostgreSQL - mssql if your database type is MSSQL | The `Database.Type` value that you defined in the `zetalyinstall.cnf` file. |
| `Backend.MYZ.DB.Username` | Database user used by the MYZ module. | The `Database.UserName` value that you defined in the `zetalyinstall.cnf` file. |
| `Backend.MYZ.DB.Password` | MYZ module database user's password. | The `Database.Password` value that you defined in the `zetalyinstall.cnf` file. |
| `Backend.MYZ.DB.HostAddress` | Database host address used by the MYZ module. Can be an IP address or a domain name. | The `Database.Host.Base` value that you defined in the `zetalyinstall.cnf` file. |
| `Backend.MYZ.DB.Name` | Name of the database used by the MYZ module. | The `Database.Name` value that you defined in the `zetalyinstall.cnf` file. |
| `Backend.MYZ.DB.GenerationMode` | Generation mode for the MYZ module's internal database. Possible values: - update (Update the database structure only, default) - drop-and-create (Drop and create the database at launch. Test purpose only) | update |

**ZDE Related Database Properties**

| Property | Description | Default Value |
| --- | --- | --- |
| `Backend.ZDE.DB.Kind` | Database type used by the ZDE module. Possible values: - postgresql - if your database type is PostgreSQL - mssql if your database type is MSSQL | The `Database.Type` value that you defined in the `zetalyinstall.cnf` file. |
| `Backend.ZDE.DB.Username` | Database user used by the ZDE module. | The `Database.UserName` value that you defined in the `zetalyinstall.cnf` file. |
| `Backend.ZDE.DB.Password` | ZDE module database user's password. | The `Database.Password` value that you defined in the `zetalyinstall.cnf` file. |
| `Backend.ZDE.DB.HostAddress` | Database host address used by the ZDE module. Can be an IP address or a domain name. | The `Database.Host.Base` value that you defined in the `zetalyinstall.cnf` file. |
| `Backend.ZDE.DB.Name` | Name of the database used by the ZDE module. | The `Database.Name` value that you defined in the `zetalyinstall.cnf` file. |
| `Backend.ZDE.DB.GenerationMode` | Generation mode for the ZDE module's internal database. Possible values: - update (Update the database structure only, default) - drop-and-create (Drop and create the database at launch. Test purpose only) | update |

**ZHB Related Database Properties**

| Property | Description | Default Value |
| --- | --- | --- |
| `Backend.ZHB.DB.Kind` | Database type used by the ZHB module. Possible values: - postgresql - if your database type is PostgreSQL - mssql if your database type is MSSQL | The `Database.Type` value that you defined in the `zetalyinstall.cnf` file. |
| `Backend.ZHB.DB.Username` | Database user used by the ZHB module. | The `Database.UserName` value that you defined in the `zetalyinstall.cnf` file. |
| `Backend.ZHB.DB.Password` | ZHB module database user's password. | The `Database.Password` value that you defined in the `zetalyinstall.cnf` file. |
| `Backend.ZHB.DB.HostAddress` | Database host address used by the ZHB module. Can be an IP address or a domain name. | The `Database.Host.Base` value that you defined in the `zetalyinstall.cnf` file. |
| `Backend.ZHB.DB.Name` | Name of the database used by the ZHB module. | The `Database.Name` value that you defined in the `zetalyinstall.cnf` file. |
| `Backend.ZHB.DB.GenerationMode` | Generation mode for the ZHB module's internal database. Possible values: - update (Update the database structure only, default) - drop-and-create (Drop and create the database at launch. Test purpose only) | update |

**ZUP Related Database Properties**

| Property | Description | Default Value |
| --- | --- | --- |
| `Backend.ZUP.DB.Kind` | Database type used by the ZUP module. Possible values: - postgresql - if your database type is PostgreSQL - mssql if your database type is MSSQL | The `Database.Type` value that you defined in the `zetalyinstall.cnf` file. |
| `Backend.ZUP.DB.Username` | Database user used by the ZUP module. | The `Database.UserName` value that you defined in the `zetalyinstall.cnf` file. |
| `Backend.ZUP.DB.Password` | ZUP module database user's password. | The `Database.Password` value that you defined in the `zetalyinstall.cnf` file. |
| `Backend.ZUP.DB.HostAddress` | Database host address used by the ZUP module. Can be an IP address or a domain name. | The `Database.Host.Base` value that you defined in the `zetalyinstall.cnf` file. |
| `Backend.ZUP.DB.Name` | Name of the database used by the ZUP module. | The `Database.Name` value that you defined in the `zetalyinstall.cnf` file. |
| `Backend.ZUP.DB.GenerationMode` | Generation mode for the ZUP module's internal database. Possible values: - update (Update the database structure only, default) - drop-and-create (Drop and create the database at launch. Test purpose only) | update |

**ZQM Related Database Properties**

| Property | Description | Default Value |
| --- | --- | --- |
| `Backend.ZQM.DB.Kind` | Database type used by the ZQM module. Possible values: - postgresql - if your database type is PostgreSQL - mssql if your database type is MSSQL | The `Database.Type` value that you defined in the `zetalyinstall.cnf` file. |
| `Backend.ZQM.DB.Username` | Database user used by the ZQM module. | The `Database.UserName` value that you defined in the `zetalyinstall.cnf` file. |
| `Backend.ZQM.DB.Password` | ZUP module database user's password. | The `Database.Password` value that you defined in the `zetalyinstall.cnf` file. |
| `Backend.ZQM.DB.HostAddress` | Database host address used by the ZQM module. Can be an IP address or a domain name. | The `Database.Host.Base` value that you defined in the `zetalyinstall.cnf` file. |
| `Backend.ZQM.DB.Name` | Name of the database used by the ZQM module. | The `Database.Name` value that you defined in the `zetalyinstall.cnf` file. |
| `Backend.ZQM.DB.GenerationMode` | Generation mode for the ZQM module's internal database. Possible values: - update (Update the database structure only, default) - drop-and-create (Drop and create the database at launch. Test purpose only) | update |

In our example we would like to have some of the Zetaly modules using a separate database, as summarized in the table below.

| Module | Use Separate Database | Separate Database Configuation |
| --- | --- | --- |
| ZRP | Yes | First Database : MSSQL Database on a server with IP address 10.0.5.10, database name zetalydb_zrp1, database user zetaly_dbuser_zrp1, database password poghratehgj53z Second Database : MSSQL Database on a server with IP address 10.0.5.10, database name zetalydb_zrp2, database user zetaly_dbuser_zrp2, database password hkdykmpdre9h25d |
| MYZ | No | Not applicable. |
| ZDE | Yes | MSSQL Database on a server with IP address 10.0.5.12, database name zetalydb_zde, database user zetaly_dbuser_zde, database password zatryoreh |
| ZHB | No | Not applicable. |
| ZUP | No | Not applicable. |
| ZQM | Yes | MSSQL Database on a server with IP address 10.0.5.15, database name zetalydb_zqm, database user zetaly_dbuser_zqm, database password zanmeuireh |

In this case you would create the following section at the end of the `zetalyinstall.cnf` file.

```
###################################################################
#                     Seperate Module Databases                   #
###################################################################
Backend.ZRP.DB.Kind                      =      MSSQL
Backend.ZRP.DB.Username                  =      zetaly_dbuser_zrp1
Backend.ZRP.DB.Password                  =      poghratehgj53z
Backend.ZRP.DB.HostAddress               =      10.0.5.10
Backend.ZRP.DB.Name                      =      zetalydb_zrp1
Backend.ZRP.Zetaly.DB.Kind               =      MSSQL
Backend.ZRP.Zetaly.DB.Username           =      zetaly_dbuser_zrp2
Backend.ZRP.Zetaly.DB.Password           =      hkdykmpdre9h25d
Backend.ZRP.Zetaly.DB.HostAddress        =      10.0.5.10
Backend.ZRP.Zetaly.DB.Name               =      zetalydb_zrp2
Backend.ZDE.DB.Kind                      =      MSSQL
Backend.ZDE.DB.Username                  =      zetaly_dbuser_zde
Backend.ZDE.DB.Password                  =      zatryoreh
Backend.ZDE.DB.HostAddress               =      10.0.5.12
Backend.ZDE.DB.Name                      =      zetalydb_zde
Backend.ZQM.DB.Kind                      =      MSSQL
Backend.ZQM.DB.Username                  =      zetaly_dbuser_zqm
Backend.ZQM.DB.Password                  =      zanmeuireh
Backend.ZQM.DB.HostAddress               =      10.0.5.15
Backend.ZQM.DB.Name                      =      zetalydb_zqm
```

### Changing the Default Importation Method for Already Existing Dashboards

By default the installer overwrites any already existing dashboards with those from the installer. The BI.Dashboards.ImportAction property lets you change type of importation method to use for already existing dashboards, and choose from one of the following values:

- duplicate - the imported dashboard is created on the target server with a new name.
- overwrite - the existing dashboard is overwritten on the target server (default).
- skip - the imported dashboard is skipped if it exists on the target server.
- none - no action is taken. Dashboards will not be imported on the target server (even if they are not present).

If for example you want the installer to create duplicate dashboards during the installation you would create the following section at the end of the `zetalyinstall.cnf` file.

```
###################################################################
#                   Dashboard Importation Method                  #
###################################################################
BI.Dashboards.ImportAction                      =      duplicate
```