Windows8.x

SaaS Bridge Client Installation and Configuration on Windows8.x

This article describes the steps to install and configure the OvalEdge Bridge Client on Windows operating systems.

The OvalEdge Bridge Client enables secure communication between the OvalEdge SaaS platform and customer-managed data sources hosted on-premises or in cloud environments. It allows organizations to use the OvalEdge SaaS platform without exposing internal data sources directly to the internet.

The Bridge Client is installed within the organization's environment and securely communicates with the OvalEdge cloud platform. This setup requires only the client IP address and port to be whitelisted, eliminating the need to modify firewall rules or create inbound connections to internal systems.

Installation Overview

Perform the installation in the following sequence:

1. Verify Prerequisites.

2. Configure Access Policies in the Apache NiFi UI Side

3. Configure the OvalEdge Application

4. Bridge Setup on Client Virtual Machine

5. Validate Connectivity

6. Bridge Registration

7. Bridge Client Installation

8. Post-Installation Configuration

9. Configure Bridge Settings

10. Validate Bridge Connectivity

Purpose

The purpose of this document is to provide detailed instructions for:

• Preparing the Windows environment for Bridge installation

• Installing and configuring OpenJDK 21

• Installing and registering the OvalEdge Bridge Client

• Validating connectivity between the Bridge Client and Bridge Server

• Configuring the Bridge Client as a Windows service

• Verifying successful installation and operation

Prerequisites

• Verify firewall, proxy, and network requirements for the Bridge and target data sources before deployment.

• Confirm that all required third-party software and dependencies are installed and compatible before starting the installation.

Installation Files

Obtain the following installation files from the OvalEdge GCS team before starting the installation:

File Name	Description
Bridge Secure Connectivity Pack (.zip)	Contains certificates and configuration files required for secure communication between the Bridge Client and Bridge Server.
Bridge Client Installer (.jar)	Used to install the Bridge Client
Bridge Component File (.nar)	Place this file in the NiFi lib folder after installation to enable communication with the OvalEdge SaaS platform.
Bridge as a Service Files	Required to configure the Bridge Client as a Windows service

The OvalEdge GCS team provides these files through a secure delivery mechanism. Copy all files to the target Bridge Client server before beginning the installation.

Recommended Hardware Requirements

Hardware	Configuration
RAM	32 GB
SSD	250 GB
vCPU	8

Recommended Software

Software	Version
OS	Windows
Open JDK	21.0

Whitelisting Ports

Port Type	Port	Purpose
Inbound	9443	Required for NiFi UI configuration changes
Outbound	9443	Communication from Bridge Client to Bridge Server

• The Bridge Client IP must be whitelisted in all connector data sources.

• Ensure outbound traffic on port 9443 is allowed to the Bridge Server.

OvalEdge Bridge Architecture and Communication Model

The OvalEdge Bridge uses a pull-based communication model. The Bridge Client checks the Bridge Server every 5 seconds for new commands issued from the OvalEdge platform, such as connecting to a data source, crawling metadata, or running profiling jobs.

When commands are available, the Bridge Client retrieves them from the Bridge Server, executes them within the client environment, and securely sends the results back to the OvalEdge platform. The polling interval can be configured based on operational requirements.

The Bridge enables secure communication between the OvalEdge cloud platform and client-hosted data sources without requiring direct inbound access to the client environment. All communication occurs through whitelisted, secure ports and is encrypted using TLS 1.2.

OvalEdge provides, hosts, and maintains all Bridge software components. The only component managed by the client is the virtual machine on which the Bridge Client is installed.

The Bridge simplifies secure connectivity to data sources hosted in cloud or on-premises environments while reducing network and firewall configuration requirements.

Bridge Components

Component	Description
Bridge Server	Hosted in the OvalEdge SaaS environment and communicates directly with the OvalEdge platform.
Bridge Client	Installed within the client environment (cloud or on-premises) and securely communicates with the Bridge Server.

Deployment Scenarios

Environment	Bridge Server Location	Bridge Client Location	Communication Requirement
Cloud-based Sources	OvalEdge SaaS AWS Server	Public cloud VM (provided by client)	The Client VM IP address must be whitelisted to communicate securely with the Bridge Server hosted on the SaaS VM.
On-Premise Sources	OvalEdge SaaS AWS Server	On-prem VM (provided by client)	The Client VM IP address must be whitelisted to communicate securely with the Bridge Server hosted on the SaaS VM.

• The Bridge is owned and maintained by OvalEdge.

• The client provides the VM and network configurations within their environment.

• All communications are encrypted using TLS 1.2 and SSL protocols.

Configure Access Policies in the Apache NiFi UI Side

After the Apache NiFi service starts and the NiFi UI is accessible, the flows are disabled by default. Configure the required access policies to enable the flows.

1. Log in to the Apache NiFi UI.

2. Verify that the flows are displayed in the Disabled state.

   
3. Click the Lock icon for the flow component.

4. The Access Policies window opens.

   
5. By default, the Add (+) button is disabled.

6. To enable policy assignment:

   1. Click Create.

   2. Click Add User/Group

      

      
7. Select CN=oeserver and add the user.

   
8. Repeat the same steps for each flow component.

   
9. Verify that all flows are displayed in the Enabled state.

   
10. Restart the Apache NiFi service with NIFI_CERT_MODE set to false.

Validation

• Verify that all flows are enabled and running successfully.

Expected Result

• The Apache NiFi flows are enabled, and the Bridge is ready to process requests.

Configure access policies for every flow component before restarting the Apache NiFi service.

Configure the OvalEdge Application

Before installing the Bridge Client, configure the required Bridge settings in the OvalEdge application.

Configure the Temporary Directory

1. Log in to the OvalEdge application.

2. Navigate to Administration > System Settings.

3. Search for the ovaledge.temppath system setting.

4. Set the value to: /mnt/tmp/

   

The temporary directory stores intermediate files generated during Bridge operations. Ensure the specified directory exists and has the required read and write permissions.

Configure Bridge System Settings

Configure the following Bridge system settings before installing the Bridge Client.

1. Navigate to Administration > System Settings > Bridge

System Setting	TextDescription	TextPurpose	Value
ovaledge.bridge.mode	Enable/disable bridge functionality in the application.	Controls whether the application can communicate with the Bridge service for connector operations.	true – Enables Bridge functionality. false (Default) – Disables Bridge functionality.
ovaledge.bridgesoftware.path	It helps DevOps to specify the path of the bridge software.	Allows the application to locate the Bridge software required during Bridge installation and management.	Enter a valid absolute directory path. Default: /home/ubuntu/BridgeSoftware/ Example: /mnt/BridgeSoftware/
bridge.type	Configure the bridge to Bridge Lite (REST) or NiFi.	Determines whether the application uses the Bridge Lite (REST) implementation or the NiFi-based Bridge.	REST (Default) – Activates Bridge Lite. NIFI – Activates the NiFi Bridge.
bridge.server.host	To configure the host or URL of the bridge server, allowing the system to establish connections and communication with the specified server	Enables the OvalEdge application to establish communication with the configured Bridge server.	Enter a valid Bridge server hostname or URL provided by the OvalEdge team.
bridge.nifiversion	To configure the NiFi Bridge version.	Ensures that the application uses the appropriate NiFi Bridge version compatible with the deployment.	Enter a supported NiFi Bridge version. Example: nifi-2.6.0

Obtain the Bridge Server Host value from the OvalEdge GCS team before proceeding with the installation.

Bridge Setup on Client Virtual Machine

Prepare the Bridge Client virtual machine before installing the Bridge software.

Install OpenJDK version 21

1. Download OpenJDK 21 from the following URL. https://builds.openlogic.com/downloadJDK/openlogic-openjdk/21.0.10+7/openlogic-openjdk-21.0.10+7-windows-x64.msi

2. Once Java is downloaded, double-click on the link to install Java as shown below.

   

   

3. Navigate to System Properties > Advanced > Environment variables and configure the environment variable JAVA _HOME.

   

4. Click Ok.

   

5. Open Command Prompt and check java -version.

   

Validation

• Verify Java 21 is installed.

Expected Result

• The system displays OpenJDK 21.

Validate Connectivity

Procedure

1. Identify the public IP address.

   $ curl ifconfig.me

   Share the static public or NAT IP of the VM with the OvalEdge team (GCS). The IP will be whitelisted on the OvalEdge SaaS system to allow traffic between the Bridge Client and Bridge Server.

2. Ensure that outbound traffic from the client network to the Bridge Server IP address (provided by the OvalEdge team) is allowed on port 9443.

3. Verify Connectivity to the bridge server.

   $ curl -v telnet://<bridge_server_domain>:9443

   

4. The bridge_server_domain will be provided by the OvalEdge team.

5. For the OvalEdge application to crawl data from the customer's data sources, the VM running the bridge client must be able to connect to them. The customer must ensure that the Bridge Client VM has access to the data sources.

   • Ensure the Bridge Client VM has network access to all required data sources.

   • Only required ports on the data sources should be opened for traffic from the Bridge Client VM.

   • Service accounts should have read-only access.

Validation

• Verify successful communication.

Expected Result

• The VM can communicate with the Bridge Server.

Failure Impact

• Bridge registration and communication may fail.

Bridge Registration

Procedure

1. Log in to OvalEdge.

2. Navigate to Administration > Connectors > Manage Bridge.

   
3. Click + in the top-right corner to add the Bridge.

   

4. Enter the Bridge Client static IP address.

   

5. Create the Bridge by clicking on the Save option.

6. A pop-up displays the Bridge ID and Security Code.

7. Download links for the Bridge Secure Connectivity Pack and Installation software(certificate zip file).

   

8. Copy the downloaded files to the Bridge Client VM.

9. Note the Security Code in the format below:

   BRIDGExxxxxxxxxxxxxxx

10. Click OK to create the Bridge. The new Bridge appears on the Bridge page.

    

11. Download the Bridge Installation Software file (installation jar file) shared by the OvalEdge GCS Team via email and move it to the Bridge Client VM.

    • The installation file size is approximately 700 mb.

    • Verify that the Bridge is displayed on the Bridge page after it is created.

    • The Bridge entry confirms that the Bridge was created successfully.

Bridge Client Installation

Install and register the Bridge Client.

Procedure

1. Create the following Folders in the C drive or create folders in the preferred drive location:

   1. Bridge_artifacts

   2. Bridge_client

   3. Temp

      
2. Copy the Bridge Secure Connectivity Pack (zip file) and ovaledge-bridge-client-installer.jar into the bridge_artifacts folder.

3. Run:

      java -jar <installer>.jar

   
4. After running the JAR file, the installation screen appears. Click Next to continue.

   

5. When prompted, select the installation directory for the Bridge Client.

   1. The default installation path is C:\ovaledge\ovaledge_bridge.

   2. Enter the path to the bridge_client folder created earlier.

      
   3. Click Next to continue the installation.

      

Field Name	Description
Authentication Token	Authentication token used to securely register and authenticate the Bridge Client with the Bridge Server.
Bridge Host IP Address	IP address or hostname of the Bridge Server that the Bridge Client connects to.
Bridge Name	Unique name used to identify the Bridge within the OvalEdge application.
Cloud Server URL	URL of the OvalEdge SaaS server that communicates with the Bridge Client.
Certificates Path	Directory path containing the SSL/TLS certificates required for secure communication between the Bridge Client and the Bridge Server.
Bridge Temp Directory	Directory used by the Bridge Client to temporarily store files and processing data during execution.
User Name	Name of the user responsible for configuring or managing the Bridge.
User Email	Email address of the Bridge administrator or contact person.
User Phone	Contact phone number of the Bridge administrator or support contact.
Enable askEdgi (True/False)	Enables or disables askEdgi support for the Bridge. Set the value to True to enable askEdgi or False to disable it.

1. Enter the Security Code noted during the bridge creation process.

2. Provide the same IP Address used when adding the bridge IP details in the OvalEdge application under the Machine IP Address field.

3. Enter a Bridge Name to identify the Bridge Client.

4. Enter the Cloud Server URL shared by the OvalEdge team.

5. For the Certificates Path, enter the location of the Bridge Secure Connectivity Pack (ZIP file) copied earlier to the VM.

6. For the Bridge Temp Path, enter the location of the temp path on the VM.

7. Enter the User Name and Email Address, then press 1 and Enter to confirm.

   The user details are mandatory and must be entered without spaces.

8. For NIFI service creation, enter the service name.

9. For askEdgi,

   1. Enter true if you are enabling askEdgi.

      For the Certificates path and Bridge Temp Directory on a Windows machine, the user must use the forward slash "/".Example: C:/ovaledge/certificates. Once all details are submitted, click "Next." Wait for the packages to download, then click "Next" again as shown below.

   2. Enter false if you are not enabling the askEdgi.

      

      
10. Wait for the installation to complete. A message stating “Installation was successful” will appear.

    

    

11. Click on Done. NiFi will start automatically.Click on Done. NiFi will start automatically.

    • Verify that the installation completes without any errors.

    • A successful installation confirms that the Bridge Client is installed correctly.

    • If incorrect configuration values are provided during installation, the Bridge Client may not be able to communicate with the Bridge Server.

Post-Installation Configuration

Copy Required Files

Procedure

1. Copy the bridge-oe-.nar file to the installed NiFi lib folder. Ex: Windows (C:) > ovaledge > bridge_Client > nifi2.6.0 > lib

2. Start or restart the NiFi service from the NiFi bin folder using the command:

   $ nifi.cmd start

   

Validation

• Verify NiFi starts successfully. Ex: Windows (C:) > ovaledge > bridge_Client > nifi2.6.0 > nifilog

• After restarting, check the NiFi logs to confirm that the service has started correctly.

• Verify the bridge status from the OvalEdge application UI.

• The bridge status should display as green, indicating successful installation and connectivity.

  

Expected Result

NiFi is running, and Bridge components are loaded.

Configure Bridge Settings

Procedure

1. Navigate to Administration > System Settings > Bridge.

   
2. Configure bridge.temppath. Example: c:\ovaledge\temp

   Please provide the path that was created in the Bridge Client VM during the Bridge installation process

3. Save the configuration.

Troubleshooting

If the Bridge status does not display Connected or Running, perform the following checks:

1. Verify that the Apache NiFi service is running on the Bridge Client machine.

2. Confirm that the Bridge Client can connect to the Bridge Server over port 9443.

3. Verify that the Bridge Client IP address is whitelisted on the Bridge Server.

4. Ensure that the Bridge configuration values, including the Bridge Host, Cloud Server URL, Security Code, and certificate path, are correct.

5. Review the NiFi logs for errors related to Bridge startup, connectivity, or authentication.

6. Restart the Apache NiFi service after correcting any configuration or network issues.

7. Verify the Bridge status again in the OvalEdge application.

If the Bridge status still does not display Connected or Running, contact the OvalEdge Support or GCS team and provide the NiFi logs, Bridge configuration details, and any relevant error messages for further investigation.

Validate Bridge Connectivity

Validation

Verify

• Bridge status displays Connected.

• Bridge status displays Running.

• Metadata crawling succeeds.

• Connector communication succeeds.

• No critical errors appear in NiFi logs.

Expected Result

The Bridge is operational and healthy.

Bridge as a Service Configuration

OvalEdge can run the Bridge Client as a Windows service, enhancing reliability and eliminating the need for manual intervention. When the Bridge is installed manually on a client machine, it must be restarted if the server or virtual machine goes down. To mitigate this risk and ensure high availability, OvalEdge provides a "Bridge as a Service" option.

This approach ensures the Bridge Client automatically restarts on system reboot, supporting seamless connectivity to client data sources. Configure the Bridge to start automatically after a server restart.

Configure NiFi as a Windows Service

Configure the NiFi application to run automatically as a Windows service.

Step 1: Download WinSW

1. Download WinSW-x64.exe from the official GitHub releases page: https://github.com/winsw/winsw/releases/latest

   

Step 2: Rename the Executable

1. Rename WinSW-x64.exe to nifi-service.exe.

2. Copy nifi-service.exe to the NiFi bin directory.

   

Step 3: Create the Service Configuration File

1. Create a file named nifi-service.xml in the same directory as nifi-service.exe.

2. Update the following placeholders in the XML file:

   1. Replace <nifi-home> with the NiFi installation directory.

   2. Replace <java-home> with the JDK 21 installation directory.

      

Step 4: Install the Windows Service

1. Open Command Prompt as an administrator.

2. Navigate to the NiFi bin directory.

3. Run the following command:

   nifi-service.exe install

4. The NiFi Windows service is installed successfully.

   

Step 5: Verify the Service

1. Open Windows Services.

2. Verify that the Apache NiFi service is listed.

   

Step 6: Start the Service

1. Select the Apache NiFi service.

2. Click Start.

3. Wait until the service status changes to Running.

   

   

Step 7: Verify the Service Logs

1. Review the NiFi log files to confirm that the service starts successfully.

2. Verify that no startup errors are reported.

   

   • NiFi uses port 9443 by default.

   • If the service runs under a user account other than the system administrator:

     • Configure the JAVA_HOME environment variable as a system variable.

     • Grant the service account Full Control permission on the entire NiFi installation directory.

     • Restart the Apache NiFi service after applying these changes.

   • After completing the Bridge and NiFi installation, validate the setup by creating and testing a connection to a supported data source.

     • In this example, a MySQL connection is used to verify that the Bridge, NiFi service, and OvalEdge platform are communicating correctly.

Validate a MySQL Connection Through the Bridge

1. Configure a MySQL connector and run connection validation through the Bridge. A successful validation confirms that the Bridge can securely connect to on-premises or client-hosted data sources and communicate with the OvalEdge platform.

   • Verify that the Apache NiFi service is running before proceeding.

   • After a system restart, confirm that the Bridge service starts automatically.

   • If the service runs under a dedicated user account, ensure that the account has the required permissions to access the NiFi installation directory and related resources.

Post-Installation Verification Checklist

Validation Item	Expected Result
Java 21 Installation	Successful
Bridge Registration	Successful
NiFi Service	Running
Bridge Status	Running
Metadata Crawling	Successful
Connector Validation	Successful
Application Logs	No Critical Errors

---

Copyright © 2026, OvalEdge LLC, Peachtree Corners, GA, USA.