Windows Configuration Properties

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

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.

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.

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 

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.

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.

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.

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.
The following table summarizes the default values for the ZAC related properties used by the installation script.

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

MYZ Related Database Properties

ZDE Related Database Properties

ZHB Related Database Properties

ZUP Related Database Properties

ZQM Related Database Properties

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

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