Zetaly Installation - Windows
    • 04 Aug 2023
    • 3 Minutes to read
    • Contributors
    • Dark
      Light

    Zetaly Installation - Windows

    • Dark
      Light

    Article summary

    ZEX last version  (April 2023, "751")

    The product will not have new update.


    The Zetaly Suite is composed of multiple modules. Each module can be installed or upgraded separately, but Zetaly provides a tool to simplify the installation process.

    Notice
    The Windows installation is now deprecated, except for the ZSI module. The recommended installation for Zetaly is now Docker Linux, which is detailed on this page.
    The ZSI installation procedure can be found here.

    Requirements

    The requirements to install Zetaly on Windows are as follows:

    • Database server : PostgreSQL version 11+
    • Dedicated Windows 10 or Windows Server 2008 R2 through Windows Server 2019
    • RAM : 32 GB minimum
    • Storage : 2 To minimum 
      Note: Can vary according to your needs. See with your Zetaly commercial representative to get an estimation.
    • Ports (non-mentioned modules are configurable): 
      • ZSI: 
        • 22
        • 80
        • 111
        • 179
        • 443
        • 6443
        • 9099
        • 9100
        • 30030
        • 30845
        • 10249 - 10259
        • 2379 - 2380
        • 24007 - 24008
        • 24007 - 24008
        • 30000 - 39999
        • 49152 - 49157
    • PowerShell 7 in administrator mode
    • Unrestricted execution policy
      PowerShell
      Set-ExecutionPolicy -Scope Process -ExecutionPolicy Unrestricted
    • If using SSL/TLS for the Zetaly Portal: Certificate created for the host machine, named 'domain.crt' & 'domain.key'
    • ZSI only : 
      • License, admin user and admin password, provided by Zetaly Support
      • Certificate created for the host machine (required)
    • ZCC/ZSA : ASP .net Core Runtime v6

    Configuration

    Unzip your Zetaly Suite package folder and edit the configuration file named zetalyinstall.cnf.

    The zetalyinstall.cnf file contains all the configuration properties required for the installation. For a default installation, we recommend you only change the properties summarized below:

    PropertyDescription
    BI.LicenseFileLicense file for the BI Tool
    BI.UserNameBI Tool username
    BI.PasswordBI Tool password
    Frontal.Host.BaseHost adress of the current machine
    Frontal.Certif.CrtFull path to the domain.crt certificate
    Frontal.Certif.KeyFull path to the domain.key certificate
    Database.TypeDatabase type (postgresql/mssql)
    Database.Host.BaseDatabase ip/domain
    Database.NameDatabase name
    Database.UserNameDatabase user name
    Database.PasswordDatabase user password
    Database.Admin.UserNameDatabase admin user name
    Database.Admin.PasswordDatabase admin password
    ZEX.LicenseFileLicense file for Zetaly Explorer
    ZEX.ModeMode Client (1) or Server (2)
    Database
    The installer provides the ability to install each module database on different servers. For a first installation, Zetaly recommends you use the same database.

    Installation

    Once you have defined the properties in the configuration file, open PowerShell 7 in administrator mode. 

    Go to your Zetaly Suite package folder, and launch following command:

    .\zetalyinstall.ps1 Database-Create-User

    This command creates the user for Zetaly database, using the admin user.

    You can skip this step if the user does not need to be created.

    Create the Zetaly database and install all the modules using the following command:

    .\zetalyinstall.ps1 all-init

    This command launches the following installations:

    When the installation is complete, you can access the Zetaly Portal with your web browser on port 80. You are prompted with log in using the administrator account that you created during the installation. Refer to the User creation and login documentation for more details.

    Next step is to configure Zetaly Explorer to be able to collect data from your mainframe. 

    Please, refer to this article.

    Upgrading an Existing Installation

    Upgrading occurs when you already have an installation and you install a newer version. Rollbacks are not supported by the Zetaly installer. 

    To do so, report your current configuration information into the new package's configuration file and launch the same command as for a first installation. None of your data is modified, unless a specific warning is indicated in the release notes (they are referred as "breaking changes"). 

    Database upgrades are always necessary when upgrading Zetaly

    The installer can detect if your database is already up to date, it is a good habit to do them every upgrade.

    The CNF file format can change between versions !
    Remember to always compare the content of your previous cnf file with the new one before replacing eveything. Never replace the file or overwrite its content before doing so.
    Many tools can help you do this automatically rather than comparing line by line by hand.

    An example :

    # Launched in powershell 7 in administror mode
    
    ./zetalyinstall.ps1 Front ZHB ZCC BI Database-update
    You can always use the 'help' command if you have any doubt
    ./zetalyinstall.ps1 help

    Upgrading ZSI

    Upgrading ZSI can be done the same way as any other module (i.e. ./zetalyinstall.ps1 BI), which runs the following :

    • Bi Tool update (if needed)
    • Bi configuration (SSO, plugins, specific configuration...) (if needed) 
    • Elasticubes import
    • Dashboards import

    If you have any elasticubes with data or customized some dashboards, it is strongly recommended to back them up, or discard the automatic update (use of Elasticubes.ImportAction=skip) !

    You can selectively update cubes and dashboards using the commands cube-update and/or dashboard-update, followed by the cubes/dashboards names to update.

    The dashboards and cubes updated by a package version are specified in the release notes, under the ZSI section.

    Upgrading the ZSA Mainframe Part

    The mainframe upgrade is similar to the first installation. To upgrade the mainframe, do the following: 

    1. Upload the package to the mainframe (Binary).
    2. Stop all the tasks that are using the current LOADLIB.
    3. Rename the current loadlib to another name.
    4. Rename the new loadlib to the current name.
    5. Start again the tasks. 

    Refer to the First installation guide in doubt.







    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.