Remote Agent

Introduction

DBSync Remote Agent is a lightweight service that enables secure communication between your on-premise systems and the DBSync Cloud Workflow (CW) platform. It acts as a bridge that facilitates the movement of data between internal systems (like databases or ERPs) and cloud-based applications, even if the internal systems are behind a firewall.

Remote Agents are especially useful for:

• Integrating on-premise databases, file systems, or other services with cloud applications.

• Ensuring secure communication through encrypted protocols.

• Handling scenarios where direct internet access is not feasible.

Note: You only need the Remote Agent if you're connecting an on-premise system. For cloud-only integrations, no installation is required.

System Requirements

If you are utilizing the DBSync Remote Agent for on-premise integrations, please ensure your system meets the following requirements:

Supported Operating Systems

• Windows:

  • Windows 10 or later

  • Windows Server 2016 or later

• macOS:

  • macOS Monterey (12) or later

• Linux:

  • Ubuntu 20.04 LTS or later

  • Red Hat Enterprise Linux 8 or later

  • CentOS 8 or later

Software Requirements

• Java: Oracle Java JDK 1.8 or higher (32-bit or 64-bit, based on server configuration).

Hardware Requirements

• CPU: 1 GHz or better processor

• RAM: 1 GB free RAM

• Disk Space:

  • Installation: 150 MB free space

  • Map/Process Store: 5 MB per map

  • Operational: 1 GB (for log files, event queues, etc.)

Note: Windows 7, Windows Vista, and Windows 2003 Server are no longer supported.

Remote Agent Dashboard Overview

The Remote Agents dashboard has the following fields displayed;

Group Name: The name provided for the group of users pertaining to the same agent.

Status: Displays the status (active or inactive) of the Agent using color code (red - inactive, green - active).

• Warning Status (For select iterations): This will be displayed if the group has mixed agent status, such as Running and Stopped. If group A has 2 agents, where one of the agents is currently running and the other agent is stopped, the group status indicates.
• Running: indicates that the agent is running without any issues.
• Stopped: will indicate when the agent is stopped due to various issues.

Last Ping: Displays the timestamp of the last active session occurred in the users' time zone.

Actions: Displays Edit and Delete options where the user can either delete the group or edit the configurations of the group.

• Agent Action: User can start or stop the agent by clicking the icon

Create New Group

Create a new group by following the steps given below.

Step 1: Click + Group to add a new agent group.

Step 2: Input the following information in each of the fields provided in the popup window.

1. Name: The User can provide a name for the group.

2. Owner: The User can assign an owner of the group by selecting the user name from the dropdown list.

3. Receive Notifications: Select or deselect the checkbox to receive notifications regarding the agent's start and stop.

NOTE:

1. Every time a new group is created, a non editable Group ID will be generated by the system.

1. An Owner is a user in your DBSync instance.

Step 3: Click Save to confirm the creation of the new group.

Download and Installation

Step 1: Download the Remote Agent

You can download the Remote Agent package for your operating system from the Remote Agent Downloads page.

Step 2: Install the Remote Agent

• Unzip the downloaded file.

• Navigate to the extracted tomcat/bin folder and run the remoteagent.bat file.

• After installation, confirm that the DBSync Remote Agent service is running via the Windows Services panel.

Configuration

After installation, configure the Remote Agent to connect securely with the DBSync Cloud Workflow.

1. Open your browser and navigate to the local configuration URL: http://localhost:8080/cw/api/v2/agent/configuration
2. On the configuration page, provide the following details:

   • Group ID (from the group you created in Cloud Workflow)

   • Agent Name (a unique identifier for the agent)

   • Any other required configuration values

3. Click Submit to complete the registration.

4. You can navigate to the desired flow page and choose the appropriate remote agent from the dropdown menu.

Agent Notification Emails

When an Agent starts or stops, the owner is alerted on the events through an email.

The following information is listed in the email that the owner receives.

Start

• Subject: DBSync CloudWorkflow Remote Agent: <name> Started

• Body: DBSync CloudWorkflow Remote Agent: <name> Started at Time: <time in UTC> UTC

Stop

• Subject: DBSync CloudWorkflow Remote Agent: <name> unreachable

• Body: DBSync CloudWorkflow Remote Agent: <name> is unreachable since: <time in UTC> UTC