Installing on Windows Nano Server or Windows IoT Core
Adding Zen to Specialized Windows Operating Systems
The following topics cover installation and configuration of Zen Enterprise Server, Edge Server, Client, and Client Reporting Engine on Windows Nano Server and Windows IoT Core:
Before You Install on Windows Nano Server or IoT Core
Before installing Zen on these platforms, we recommend you review the release notes from the Actian website. Also, be aware that throughout the documentation, all references to Zen Enterprise Server apply to installations on Windows Nano Server and IoT Core systems as well.
You must be logged in as administrator to install Zen on Windows IoT Core.
Special Instructions Before Installing Nano Server in a Docker Container
The release of Windows Nano Server 2019 is supported only in a Docker container. Building Nano Server 2019 in a Docker container to install Actian Zen would involve pull commands like those given here.
Windows Platform
For Windows 10 Professional, the image can be pulled by the following command:
The Zen database engine requires the netapi32.dll to load and run properly. This standard Windows DLL is not included by default in the Nano Server image. To include the needed file, add the following line to your dockerfile. The string nnnn refers to the Windows image that you pulled.
After you have completed these instructions and executed docker run to run a dockerfile like the following sample, you can continue with the steps under Installing Using PowerShell.
Sample Dockerfile
# escape=`
# Args used by from statements must be defined here
ARG InstallerVersion=nanoserver-1809
ARG InstallerRepo=mcr.microsoft.com/powershell
# Use powershell with nanoserver
FROM ${InstallerRepo}:$InstallerVersion
USER ContainerAdministrator
# In the following line, the /M is required to address a known Docker issue in Windows Nano Server 2019.
RUN setx PATH "%PATH%;%ProgramFiles%\PowerShell;" /M
#Pull in netapi32.dll from servercore
## FROM mcr.microsoft.com/windows/servercore as core
Microsoft PowerShell and the .zip archive format are used to install Zen on Windows Nano Server or IoT Core. The following topics explain how to use these to install Zen.
In the file name, yy.yy is a release number and zzz.zzz is a build number. See the file for its actual name.
A server installation includes the engine and client files and selected utilities. Client installations provide only files and utilities needed to support a client. Client Reporting Engine installations are the same as those on other Windows platforms.
Your installation is either a first time, with no previous version, or an upgrade to an existing installed version.
First-Time Installation on Windows Nano Server or IoT Core
2 Extract the installation .zip archive to a location accessible to the PowerShell session that will execute the installation script.
3 In the extracted files, run Install-Zen.ps1 with an argument to select the Zen product.
•For Nano Server, the arguments are enterpriseserver, edgeserver, client, or reporting.
•For IoT Core, the arguments are enterpriseserver or edgeserver.
Note: See information about Zen Edge Server on IoT Core after these steps.
The installation displays progress information in the console and creates a log file in the user's temp folder $env:temp. The name of the log file reflects the type of installation that was chosen: Zen_<type>_PowerShell_Install.log.
After installation, you can reclaim disk space by removing the .zip archive and its extracted files.
About Zen Edge Server on Windows IoT Core
An Edge Server installation is identical to the Enterprise Server installation except for the following:
•License can be activated only on Universal Windows Platform (UWP) systems with 4 GB memory or less.
•Applies the temporary license key in the file install_edgeserver.cfg.
•Adds "INFO: Total Physical Memory : <size_in_bytes>" in the file Zen_EdgeServer_PowerShell_Install.log.
Windows Firewall Configuration
Zen installation for Windows Nano Server and Windows IoT Core systems requires that Windows Firewall rules allow communication through the firewall. These rules are not enabled by default. To enable them, run the PowerShell script Enable-ZenFirewallRules.ps1, which is included in a default Zen installation in C:\Program Files\Actian\Zen\bin. If needed, you can enter one of the following arguments to enable the rules only for the specified Windows Firewall profile:
•domain
•private
•public
•any (default)
The following example enables the firewall with the domain argument:
If you enter no argument, then rules for all Windows Firewall profiles are enabled, the same as if you had entered the argument any. After the script is executed, it displays the current state of the rules for all profiles.
Upgrade Installation on Windows Nano Server or IoT Core
To upgrade an existing installed version of Zen on Windows Nano Server and Windows IoT Core, repeat the installation steps using a new .zip archive.
You do not need to redo changes made to Windows Firewall rules after the first installation.
After Installing on Windows Nano Server or IoT Core
The following topics may be useful after installation. Throughout the documentation, references to Zen Enterprise Server apply to installations on Windows Nano Server and IoT Core systems.
All configuration settings for Zen Enterprise Server are available on Windows Nano Server and IoT Core. Generally, the default configuration settings are sufficient. For information on these settings, see Configuration Reference in Advanced Operations Guide.
On both Windows Nano Server and IoT Core, Zen uses license keys instead of product keys.
Code Page Configuration on Windows IoT Core Systems
In the current release, the code page for a Zen installation on Windows IoT Core defaults to Western European 1252. You can change the code page using PowerShell. For example, if you want to change the setting to Microsoft Windows 932 for Japanese systems, use the following command:
If you have problems with your installation, see Troubleshooting After Installation or get help online from the Zen knowledge base at the Actian website. The following are common questions after installation of the products:
How Can I Verify That the Database Engine is Running?
After the installation script finishes, you can verify that the database engine is running with the PowerShell Get-Service command. To do so, enter the following at a command prompt:
Get-Service -DisplayName "Actian Zen Enterprise Server"
If the engine is running, this command returns the following:
Status Name DisplayName ------ ---- ----------- Running zenengine Actian Zen Enterprise Server
If the server engine is stopped, you can use the following command to manually start it:
Start-Service -DisplayName "Actian Zen Enterprise Server"
The engine service starts automatically with the operating system. If you need to stop the service, use the following command:
Stop-Service -DisplayName "Actian Zen Enterprise Server"
After running this command, the Get-Service command returns the following:
Status Name DisplayName ------ ---- ----------- Stopped zenengine Actian Zen Enterprise Server
What Utilities Are Installed?
On Nano Server systems, Zen provides a subset of the command line utilities that are available in full installations. These utilities consist of the following:
bcfg
butil
dbdefrag
bdu
clilcadm
pvddl
bmon
clipaadm
pvnetpass
On IoT Core systems, the utilities consist of the following:
bcfg
butil
dbdefrag
bdu
clilcadm
pvddl
bmon
clipaadm
pvnetpass
Where Do Files Reside After Installing?
The following table lists the primary directories and files installed for Zen products on Windows Nano Server or IoT Core. The variable %ALLUSERSPROFILE% is used to determine the location of some files, while others default to C:\Program Files\Actian\Zen.
Location
File
Description
Installation
C:\Program Files\Actian\Zen
See description
License information in a file:
•Windows Nano Server and IoT Core: EULA_en.rtf or EULA_Client_en.rtf
No documentation is included in a Zen installation on Windows Nano Server or IoT Core. You may use the documentation installed with other Zen editions or posted on the Actian documentation website.
Where Are the Release Notes?
The release notes contain general information about the release, sometimes including late-breaking advice not yet covered in the user documentation. Although this document is not included in installations on Windows Nano Server or IoT Core, the Actian website posts the latest version.
Uninstalling on Windows Nano Server or IoT Core
Use the following steps to remove Zen from your system.
►To remove Zen from Windows Nano Server or IoT Core
To remove Zen from the system, you use the script Uninstall-Zen.ps1. This script is located in the Zen bin folder C:\Program Files\Actian\Zen\bin. You should invoke it from a working directory located outside that path, as shown in the example used here.
1 On the system where Zen is installed, start a PowerShell session as Administrator.
2 Set the location as shown here:
PS> Set-Location c:\
Note If the script is invoked from a location that is in the Zen installation folder path, the Zen files and directories are not removed, and you must manually delete them after running the removal script.