Zetaly Installer - User Manual

Prev Next

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

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.

Commands

Help

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

.\zetalyinstall.ps1 all

Launches the installation of the following: 

  • Database-Init 
  • BI 
  • Back 
  • Front 
  • Proxy 
  • Zetaly Explorer
.\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 

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

PropertyEditable (Yes/No)DescriptionValue(s)
Database.Admin.UserNameYesUsername used to create the Zetaly user
Database.Admin.PasswordYesUser password
Database.UserNameYesZetaly user to create
Database.PasswordYesZetaly user password

Database Creation

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

PropertyEditable
(Yes/No)
DescriptionValue(s)
Database.TypeYesType of database
Database.Host.BaseYesAddress of the Zetaly database
Database.NameYesName of the database
Database.UserNameYesUsername of the database
Database.PasswordYesPassword of the database

Database Update

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

PropertyEditable
(Yes/No)
DescriptionValue(s)
Database.TypeYesType of database
Database.Host.BaseYesAddress of the Zetaly database
Database.NameYesName of the database
Database.UserNameYesUsername of the database
Database.PasswordYesPassword of the database

BI

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

PropertyEditable
(Yes/No)
DescriptionValue(s)
BI.FileNameNoLocation of the BI Tool installer./Sisense*.exe
BI.VersionNoSpecific version of the BI Tool8.2.3.10108
BI.LicenseFileYesLocation of the BI Tool license file
BI.UsernameYesUsername of the BI Tool user
BI.PasswordYesPassword of the BI Tool user
BI.ProtocolYesProtocol to access BI Tool(DEPRECATED) https only 
BI.HostAddressYesAddress to access BI Toollocalhost
*.*.*.*
BI.PortNumberYesPort to access BI Tool8081
BI.Mail.HostYesBi mail hostname[BI.HostAddress]
BI.Mail.PortYesBi mail port[BI.PortNumber]
BI.Mail.UserYesBi mail username[BI.UserName]
BI.Mail.PassYesBi mail password[BI.Password]
BI.Mail.TimeoutYesBi mail Timeout999
BI.Mail.UseTlsYesUse TlsFalse
BI.Mail.IgnoreTlsYesIgnore TlsFalse
BI.Mail.RequireTlsYesNeed TlsFalse
BI.Mail.LoggerYesActive Bi mail logsTrue/False
BI.Dashboards.ImportActionYesType 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.ImportActionYesAction to realize when importing the new ElastiCubes
  • skip
  • overwrite
  • duplicate
  • none (no elasticube importation even if they are not present)
BI.Anonymous.EmailYesAnonymous user emailanonymous@zetaly.io
BI.Anonymous.PasswordYesAnonymous user passwordpassword

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.

.\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 overwritten
This 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.

.\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 overwritten
This command overwrites the specified dashboard(s). You will lose any of your personal updates made on the specified dashboard(s).

Proxy

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

PropertyEditable
(Yes/No)
DescriptionValue(s)
FrontalWeb.TargetDirYesLocation where the Zetaly Portal will be installedC:/zetalySuite/frontalweb
FrontalWeb.SchemeYesProtocol to access the Zetaly Portalhttp
https
FrontalWeb.UrlYesAddress to access the Zetaly Portal localhost
*.*.*.*
FrontalWeb.PortYesPort to access the Zetaly Portal443
FrontalWeb.Certif.CrtYesCertificate for httpsD:/secrets/domain.crt
FrontalWeb.Certif.KeyYesKey for https certificateD:/secrets/domain.key
FrontalWeb.ZccIsdeployedYesIf false, the ZCC module is not displayed by the Zetaly Portaltrue
false
FrontalWeb.ZccIsActivatedYesBoolean to defined if ZCC is activatedtrue
false
FrontalWeb.ZccSchemeYesProtocol to access ZCChttp
https
FrontalWeb.ZccUrlYesAddress to access ZCClocalhost
*.*.*.*
FrontalWeb.ZccPortYesPort to access ZCC5656
FrontalWeb.BiIsActivatedYesBoolean to defined if BI is activatedtrue
false
FrontalWeb.BISchemeYesProtocol to access BIhttp
https
FrontalWeb.BIUrlYesAddress to access BIlocalhost
*.*.*.*
FrontalWeb.BIPortYesPort to access BI8081
FrontalWeb.AscIsActivatedYesBoolean to defined if ASC is activatedtrue
false
FrontalWeb.AscIsDeployedYesIf false, the ZAC module is not displayed by the Zetaly Portaltrue
false
FrontalWeb.AscSchemeYesProtocol to access ASChttp
https
FrontalWeb.AscUrlYesAddress to access ASClocalhost
*.*.*.*
FrontalWeb.AscPortYesPort to access ASC8082
FrontalWeb.ZrpIsActivatedYesBoolean to defined if ZRP is activatedtrue
false
FrontalWeb.ZrpIsDeployedYesIf false, the ZRP module is not displayed by the Zetaly Portaltrue
false
FrontalWeb.ZrpSchemeYesProtocol to access ZRPhttp
https
FrontalWeb.ZrpUrlYesAddress to access ZRPlocalhost
*.*.*.*
FrontalWeb.ZrpPortYesPort to access ZRP8083
FrontalWeb.MyZetalyIsActivatedYesBoolean to defined if MYZ is activatedtrue
false
FrontalWeb.MyZetalyIsDeployedYesIf false, the MYZ module is not displayed by the Zetaly Portaltrue
false
FrontalWeb.MyZetalySchemeYesProtocol to access MYZhttp
https
FrontalWeb.MyZetalyUrlYesAddress to access MYZlocalhost
*.*.*.*
FrontalWeb.MyZetalyPortYesPort to access MYZ8084
FrontalWeb.ZdeIsActivatedYesBoolean to defined if ZDE is activatedtrue
false
FrontalWeb.ZdeIsDeployedYesIf false, the ZDE module is not displayed by the Zetaly Portaltrue
false
FrontalWeb.ZdeSchemeYesProtocol to access ZDEhttp
https
FrontalWeb.ZdeUrlYesAddress to access ZDElocalhost
*.*.*.*
FrontalWeb.ZdePortYesPort to access ZDE8085
FrontalWeb.ZsiIsDeployedYesIf false, the ZDE module is not displayed by the Zetaly Portaltrue
false

Backend

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

PropertyEditable
(Yes / No)
DescriptionValueProduct Version
Backend.ZCC.TargetDirYesInstallation directoryC:/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 above.

ZRP

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

PropertyEditable (Yes / No)DescriptionValueProduct Version
Backend.ZRP.TargetDirYesInstallation directoryC:/zetalySuite/ZRP/S2.6
Backend.ZRP.PortYesZRP backend port8083S2.6
Backend.ZRP.DB.KindYesZRP Database typepostgresql
mssql
S2.6
Backend.ZRP.DB.UsernameYesZRP Database username
S2.6
Backend.ZRP.DB.PasswordYesZRP Database password
S2.6
Backend.ZRP.DB.UrlYesZRP URL for jdbc driverPostgreSQL: jdbc:postgresql://myip/mydatabase
MSSQL: jdbc:sqlserver://myip;databaseName = mydatabase
S2.6
Backend.ZRP.DB.GenerationModeYesZRP Database generation-modeupdate : Update the database structure only
drop-and-create : Drop and create the database at launch. Test purpose only
S2.6
Backend.ZRP.Dino.DB.KindYesZetalyDB Database type
S2.6
Backend.ZRP.Dino.DB.UsernameYesZetalyDB Database username
S2.6
Backend.ZRP.Dino.DB.PasswordYesZetalyDB Database password
S2.6
Backend.ZRP.Dino.DB.UrlYesZetalyDB URL for jdbc driverPostgreSQL: jdbc:postgresql://myip/mydatabase
MSSQL: jdbc:sqlserver://myip;databaseName = mydatabase
S2.6
Backend.ZRP.replaceSmfIntervalGapYesAllows to fix the smf interval gapREPLACE_GAP, NOTHINGS2.6-R2022-05
Backend.ZRP.maxPeriodIntervalNumberYesMax occurrence number to fixnumber, recommanded value 2S2.6-R2022-05

MYZ

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

PropertyEditable
(Yes / No)
DescriptionValueProduct Version
Backend.MYZ.TargetDirYesInstallation directoryC:/zetalySuite/MYZ/S2.6
Backend.MYZ.PortYesMYZ backend port8084S2.6
Backend.MYZ.DB.KindYesMYZ Database typepostgresql
mssql
S2.6
Backend.MYZ.DB.UsernameYesMYZ Database username
S2.6
Backend.MYZ.DB.PasswordYesMYZ Database password
S2.6
Backend.MYZ.DB.UrlYesMYZ URL for jdbc driverPostgreSQL: jdbc:postgresql://myip/mydatabase
MSSQL: jdbc:sqlserver://myip;databaseName = mydatabase
S2.6
Backend.MYZ.DB.GenerationModeYesMYZ Database generation-modeupdate : 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.

PropertyEditable
(Yes / No)
DescriptionValueProduct Version
Backend.ZDE.TargetDirYesInstallation directoryC:/zetalySuite/ZDE/S2.6>-R2022-05
Backend.ZDE.PortYesZDE backend port8084S2.6-R2022-05
Backend.ZDE.DB.KindYesZDE Database typepostgresql
mssql
S2.6-R2022-05
Backend.ZDE.DB.UsernameYesZDE Database username
S2.6-R2022-05
Backend.ZDE.DB.PasswordYesZDE Database password
S2.6-R2022-05
Backend.ZDE.DB.UrlYesZDE URL for jdbc driverPostgreSQL: jdbc:postgresql://myip/mydatabase
MSSQL: jdbc:sqlserver://myip;databaseName = mydatabase
S2.6-R2022-05
Backend.ZDE.DB.GenerationModeYesZDE Database generation-modeupdate : Update the database structure only
drop-and-create : Drop and create the database at launch. Test purpose only
S2.6-R2022-05

Frontend

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

PropertyEditable
(Yes/No)
DescriptionValue(s)
Frontend.TargetDirNoLocation where the Zetaly website will be installed/proxy/dist

Zetaly Explorer

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

PropertyEditable (Yes / No)DescriptionValue(s)
ZEX.TargetDirYesLocation where Zetaly Explorer will be installedC:/Program Files (x86)/ZETALY Explorer
Note: must not be changed to avoid any errors. See the article about the ZEX explorer.
ZEX.LicenseFileYesLocation of your license file
ZEX.ModeYesChoose between Client or Server installation mode
  • 1 for Client
  • 2 for Server

Back and Front

.\zetalyinstall.ps1 BackAndFront

Combines the backend and frontend steps described in the Backend and Frontend sections. See the Backend and Frontend sections for more details. 

PropertyEditable
(Yes/No)
DescriptionValue(s)
Database.TypeYesType of database
Database.Host.BaseYesAddress of the Zetaly database
Database.NameYesName of the database
Database.UserNameYesUsername of the database
Database.PasswordYesPassword of the database

Cron Update jobData for SMF-30

.\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 for more details.

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

PropertyEditable
(Yes/No)
DescriptionValue(s)
Database.TypeYesType of database
Database.Host.BaseYesAddress of the Zetaly database
Database.NameYesName of the database
Database.UserNameYesUsername of the database
Database.PasswordYesPassword of the database
CRON.SystemUserYesName of your User System
CRON.TargetDirNoLocation where SQL file and batch file will be createdC:/zetalySuite/CRONS/

Troubleshooting 

See the troubleshooting page with frequently encountered problems.

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