/
Create & Deploy Remote Integrators

Create & Deploy Remote Integrators

Creating a remote integrator involves the following steps:

  1. Create and configure the remote integrator record within the Gateway Management UI.

  2. Create a password-protected key file.

  3. Transfer the key file and password to the customer, via a secure mechanism.

  4. Supply the customer with the Remote Integrator installer (directly or via URI).

  5. Authorize the remote integrator within the Gateway Management UI.

We use the term Remote Integrator and Remote Agent interchangeably. Technically, a Remote Integrator is comprised of 3 services: Remote Agent, UpdaterA, and UpdaterB.

Step 1: Create the Remote Integrator Record

In the Gateway Management UI, click the Provision New Remote Agent button.

image-20250924-161502.png

The UI will switch to the Remote Agent configuration view, where you can enter the Site Name, and optionally Keywords, Notes, and Contacts.

image-20250924-161951.png

After filling in the information, click the save button (ctrl + S).

image-20250924-162231.png

The External Key field can be used to represent a Customer ID or reference number used by other systems.

Step 2: Create the Key File

With the Remote Agent record created, we need to create the key file and password which will be transferred to the customer. Click the Export Key File button.

image-20250924-162831.png

Make note of the password and key file path, and click the Save button.

Step 3: Transfer the Key File

The key file, password, and Remote Integrator installer must be supplied to the customer. You can host the installer yourself, or supply a link to the Conevity download. The key file can be emailed to the customer. We recommend you supply the password via a separate mechanism - don’t transfer the key file and password in the same communication.

Step 4: Customer Install

Once the customer has the installer, key file, and password, they can install the Remote Integrator. At the customer site, run the installer.

image-20250924-163453.png
image-20250924-163724.png

Select the Accept EULA check box and click the Next button.

image-20250924-163845.png

Input the path to the registration file and the password. The installer will validate that a connection can be made to the Gateway, and if so, the install can continue.

InstallRA.mp4

Step 5: Authorize the Remote Integrator

Once the customer has installed the Remote Integrator, the remote agent connection status will change from Awaiting Connection to Awaiting Authorization. Although the Remote Integrator has established a connection, it is currently sand-boxed until you click the green Awaiting Authorization block.

image-20250924-181525.png

After clicking the Awaiting Authorization block, the remote integrator will be allowed to fully connect, and all operations will be available.

image-20250924-181903.png

Once a Remote Integrator is authorized, it is stamped with an immutable key. In order for this remote integrator to be re-installed, it must first be de-authorized and a new key file and password created. De-authorizing a remote agent may render all existing message data unreadable.

You can now start creating/importing channels and processing messages.

Video

This video shows creating a new Remote Integrator record, switching to another machine, copying across the key file, and then installing the Remote Integrator. It also shows the status changing in the UI and the Remote Integrator being authorized.

At the end of the video, the newly created RI is ready for channels to be created and/or imported.

ConnectRA.mp4