# 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 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.)

{% hint style="info" %}
**Note:** Windows 7, Windows Vista, and Windows 2003 Server are no longer supported.
{% endhint %}

### **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![](https://docs.mydbsync.com/~gitbook/image?url=https%3A%2F%2Flh7-rt.googleusercontent.com%2Fdocsz%2FAD_4nXdy6x2XaUImHirIgdkZppKaQrEApek--tRIiyxblqMGQRAODLO_1CY9Nc3OUaJgaeVUGhYlM_XeHG7FFJjItpGLGUfzKow7yp3eHqMxpcP8shBdAsklH6bRcu7SfocgDPuwbnXLP8MKWDCd0tmXxJnYd1B1%3Fkey%3DrexD3tNzfx5EdPfY1j2-Cw\&width=300\&dpr=4\&quality=100\&sign=858edbcc\&sv=2).
* **Running:** ![](https://lh7-rt.googleusercontent.com/docsz/AD_4nXdBn6QP_-hfKgDxVcjG_WVHxskMiJiqcfHu3Kv1Qv0Ro_aLeFs2vVWQYgJBpE2vdAsRE8F-oL6wEiN47MfhW3XlHtLH3c6m-7NfxekDLJoXfjVR0HBDMt4O6NKQTYsPLvWjpvM33QgrqWzTrwgLpBAOvJsz?key=rexD3tNzfx5EdPfY1j2-Cw) indicates that the agent is running without any issues.
* **Stopped:** ![](https://docs.mydbsync.com/~gitbook/image?url=https%3A%2F%2Flh7-rt.googleusercontent.com%2Fdocsz%2FAD_4nXdwLYoDFnCrVbsRY-nFOSW5aGG8ch0GhVPphe7Wngs6-1AN1wW1oajyxKW2h7_0abezPGBY4MKAdabDk-fXv5KG_w3EUDNApnB7f39klGSdRkCCkTXEW7utCf6PCV-SKkmeyhc7kqWu7mlTKbm4SwFyEKw%3Fkey%3DrexD3tNzfx5EdPfY1j2-Cw\&width=300\&dpr=4\&quality=100\&sign=aa6b428d\&sv=2) will indicate when the agent is stopped due to various issues.

**Last Ping:** Displays the timestamp of the last active session that occurred in the user's time zone.

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

### Create New Group <a href="#create-new-group" id="create-new-group"></a>

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.

{% hint style="info" %}
**NOTE:**&#x20;

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

2. An Owner is a user in your DBSync instance.
   {% endhint %}

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

<figure><img src="https://1036205596-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fv9avy716UiAsS24zOznZ%2Fuploads%2F5View2KO1Qe8SmyFVHbN%2Fimage.png?alt=media&#x26;token=85a267ef-5636-4eb4-8b62-f038e3cb0246" alt="" width="563"><figcaption></figcaption></figure>

### 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.&#x20;

Step 2: Install the Remote Agent

* Unzip the downloaded file.
* Navigate to the extracted tomcat/bin folder and run the  `startup.bat` file.
* After installation, confirm that the **DBSync Remote Agent** service is running via the **Windows Services** panel.

{% hint style="info" %}
To run the Remote Agent as a service, the recommended method is to launch it by clicking the `remoteagent.bat` file located in the `bin` folder.
{% endhint %}

### 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>

<figure><img src="https://1036205596-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fv9avy716UiAsS24zOznZ%2Fuploads%2Fs3sJtZ5RxwQYsXCEBgRE%2Fimage.png?alt=media&#x26;token=118f9f98-92ec-44dc-9098-503ec4625a88" alt="" width="563"><figcaption></figcaption></figure>

1. 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)
   * **User Name:** Enter the same username you use to log in to DBSync
   * **Password:** Enter your DBSync login password
2. Click **Submit** to complete the registration.
3. You can navigate to the desired flow page and choose the appropriate remote agent from the dropdown menu.

<figure><img src="https://1036205596-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fv9avy716UiAsS24zOznZ%2Fuploads%2Fz3sdROjAcW1iddtYlRlQ%2Fimage%20(12).png?alt=media&#x26;token=a2163205-0646-4ced-aa13-f87367ec2102" alt=""><figcaption></figcaption></figure>

### Agent Notification Emails

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

The following information is listed in the email that the owner receives.&#x20;

**Start**

* Subject:  Remote Agent Started
* Body: DBSync CloudWorkflow Remote Agent: \<name> Started at Time: \<time in UTC> UTC

<figure><img src="https://1036205596-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fv9avy716UiAsS24zOznZ%2Fuploads%2FacnTw1x4K7Jak6vjrhoz%2Fimage%20(13).png?alt=media&#x26;token=5f9efe4a-1c44-4394-8789-b40104882bae" alt=""><figcaption></figcaption></figure>

**Stop**

* Subject: Remote Agent unreachable
* Body: DBSync CloudWorkflow Remote Agent: \<name> is unreachable since: \<time in UTC> UTC

<figure><img src="https://1036205596-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fv9avy716UiAsS24zOznZ%2Fuploads%2FC89jHcVxpZhc77gAYNDm%2Fimage%20(13).png?alt=media&#x26;token=09807ade-ca5a-4f1b-abea-2ed386ee7e17" alt=""><figcaption></figcaption></figure>