Install a flow runtime as a Windows Service

Prerequisites

A platform that supports the minimum requirements is required.

Step 1: Download the installer

1. Open Flow manager.

2. Select Manage, then select Flow runtimes.

3. Select the Get Flow runtime artifacts icon.

   The Flow runtime artifacts dialog opens.

4. Select the Windows installation tab, then scroll down to the downloadable files.

5. Download the file for the version you want to install.

6. Unzip the file to a persistent directory, not a temp directory, on the local host server to store configuration data used by the flow runtime.

   Note: Create permission to access the Register Nodes tab is required.

Step 2: Install the Windows server

Important: Most Windows systems have a 260-character path length limitation. Avoid using overly nested directories by keeping the installation path as short as possible—ideally under 100 characters for the flow runtime root folder (Host). For example use a local folder named C:\Flows.

7. When extracting the downloaded archive, navigate to the desired destination, for example C:\Flows.

8. For a guided flow installation, double-click AvevaConnectFlowsServiceSetup.exe.

   Note: We recommend using the guided Windows installation as a starting point. Only use the .msi file for command-line or silent installations with msiexec.

9. Run the installer with elevated permissions and follow the setup instructions.

10. For new installations, enter your installation directory, Id, and AccessKey when prompted.

    After the installation is finished, the runtime should appear in CONNECT Flows and be ready for deployment.

Step 3: Python setup (optional)

Note: To use the Python Bridge module, Python 3.x must be installed. The path to the Python interpreter must be configured in the appsettings.json file, which is found in the Host\data folder, the same directory where the flow runtime is installed. In the ExternalPrograms section modify the path to the Python executable.

11. If unsure about the path to the executable, use the following command from a Windows Command Line or Powershell:

    PS C:\Users\myuser> python -c 'import os, sys; print(os.path.dirname(sys.executable))'

    C:\Program Files\Python311

    The appsettings.json file is updated to the following:

    {

    "EdgeNodeConfiguration": {

    "SERVER_CONFIGURATION_VERSION": 2.9,

    "LogLevel": "Information",

    "ExternalPrograms": {

    "Python3": "C:/Program Files/Python311/python.exe"

    }

12. (Optional) Add the path to the Python executable as a an environment variable:

    $env:python3Path = 'C:/Program Files/Python311/python.exe'

13. Restart the flow runtime service.

    The Module installs the required packages (grpcio and protobuf) automatically.

14. (Optional) For any dependency or compatibility issues, install the packages manually:

    pip install grpcio protobuf

    or

    conda install -c grpcio protobuf

Step 4: Error check

15. Validate that a green checkmark appears next to the flow runtime on the Nodes or Dashboard pages.

16. If no errors are reported, then the flow runtime is successfully running and connected to Flow manager.

Next, build and deploy flows on the new Flow runtime.