Skip to content

ZerFlow install guide

Prerequisites

Before installing ZerFlow, ensure that your machine is properly prepared.

Prerequisites

  • Zervicepoint 1.35 or later
  • .NET 10.0.3 Desktop Runtime or later
  • Internet access
  • SQL server

Zervicepoint version 1.35 or later

To use ZerFlow with Zervicepoint, you must install or upgrade to a Zervicepoint version that supports ZerFlow. Ensure that the installed version of Zervicepoint is 1.35 or later before attempting to install ZerFlow.

Make sure that the component 'Zebra API' is included when you upgrade/install Zervicepoint 1.35

If you upgrade to Zervicepoint version 1.35, you will no longer be able to downgrade to a version without ZerFlow support (e.g., 1.34.XXXX). You must continue using ZerFlow-compatible releases with version number 1.35 or later.

Instructions on how to install Zervicepoint can be found here

.NET 10.0.3 Desktop Runtime or later

To run the installer, the target machine must have .NET Desktop Runtime version 10.0.3 or later installed. You can download it from Microsoft’s website here.

Internet access

To install ZerFlow, the target machine must have access to the licensing system.

If you plan to install ZerFlow in an environment without internet access, we also offer an offline solution. Please contact Zervicepoint if you are interested in an offline-compatible installation option.

SQL Server

ZerFlow requires a SQL Server instance installed on a machine that is accessible from the machine where ZerFlow is being installed.

ZerFlow Installer

1. Start the installer

Depending on whether you plan to use Windows Authentication or SQL Authentication for the ZerFlow database, you should start the ZerFlow installer in slightly different ways.

  • Windows Authentication Open the installer using a Windows account that has permission to install services on the local machine and permission on the SQL Server to create users and databases
  • SQL Authentication Open the installer as a local administrator

2. Service Account Settings

  • Username: Enter the Windows username (e.g., DOMAIN\Username or .\Username for a local account) for the account that will run the ZerFlow background service.
  • Password: Enter the password for the specified service account.

If you are using Windows Authentication for your database authentication (see “Use SQL Authentication” in Database Settings below), this account must have appropriate permissions on the SQL Server that will host the ZerFlow database.

If you already have a service account used by Workflow Manager, DO NOT use the same account for ZerFlow. It is strongly recommended to create a separate dedicated account for ZerFlow.

3. Database Settings

  • SQL Server: Enter the name or address of the SQL Server instance where the ZerFlow database will reside (e.g., SERVERNAME, SERVERNAME\SQLEXPRESS).
  • Database: Enter the desired name for the ZerFlow database. This field is optional. If left blank, the default name ("ZerFlow") will be used or created.
  • Use SQL Authentication (Checkbox): Select this option only if you want to connect to SQL Server using an existing SQL login instead of Windows Authentication for the service account.
    • DB Username: Enter the SQL Server login username.
    • DB Password: Enter the password for the SQL Server login.

The SQL user needs permission to create both databases and users

4. ZerFlow API Settings

  • ZerFlow API Url: Enter the base URL where the ZerFlow API will be accessible (e.g., https://zerflow.example.com or https://zerflow.example.com:6443).
  • SSL Port: Enter the network port number for HTTPS traffic to the ZerFlow API (typically 6443). This field may be automatically populated or disabled depending on the URL field.
  • Certificate Name: Select the SSL certificate from the dropdown list that will be used to secure the API website (HTTPS). The list displays the certificates available on the machine.

The URL in the SSL certificate must match the URL specified in the ZerFlow API Url field

  • Signing Certificate: Select or generate a certificate that will be used to sign requests to and from the ZerFlow API.

If ZerFlow is installed on a separate server from Zervicepoint

  • Both servers need the ZerFlow Signing Certificate
  • You need to manually update some configuration files for Zervicepoint by following this instruction

5. ZerFlow Engine Settings

  • Engine version: Choose whether to use ZerFlow only, ZerFlow in combination with Workflow Manager, or continue using Workflow Manager after installation. Click here for more information in the Possible WorkflowEngine values section.
  • Engine instances: Select the number of ZerFlow instances you wish to install.

We recommend not configuring more engine instances than the number of available CPU cores initially. You can later adjust the number of engines using the ZerFlow Engine Manager to better suit your workload and performance requirements.

6. Zervicepoint Settings

Not to be confused with Zervicepoint Web API. Zebra API and Zervicepoint Web API are two different APIs

  • SSL Port: Enter the network port number used for HTTPS traffic by the Zervicepoint API (typically 7443). This field may be automatically populated or disabled depending on the URL field.

7. License & Version Settings

  • Online License: Enter your ZerFlow product license key (UUID/GUID format).
  • Verify (Button): After entering the key, click Verify. A green check mark (✔) or red cross (✘) will appear next to the field to indicate whether the license is valid. Successful verification is required before version selection and installation can proceed.
  • Version: Select the specific version of ZerFlow you wish to install from the dropdown list. This list will populate and become enabled only after successful license verification.

Buttons

  • Install: Click to begin the installation process after completing all required fields and verifying the license.
  • Uninstall: Click to remove an existing ZerFlow installation. This button is enabled only if an installation is detected.
  • Cancel: Click to close the installer without making any changes.