Skip to main content

Relays

In briefA relay is the on-premises software that lets the machines OpCon Continuum cannot reach directly — legacy LSAM machines, and OpCon MFT, OpCon RPA and EASE agents — run jobs dispatched from the cloud. It connects outbound only, so it needs no inbound firewall change, and it authenticates with a downloaded credentials.json.

WhereAgents › Relays lists every relay, with New Relay to register one and Download Relay to fetch the latest release without registering anything. Each row's menu has Edit, Rotate Credentials and Delete. The agents a relay serves are registered on the Agents tab of the same page. The relay itself runs on your own network, where it keeps its credentials.json and answers its local /health check.

When

  • You are bringing existing LSAM machines — or an OpCon MFT, OpCon RPA or EASE agent — into Continuum, and need a relay to reach them.
  • A legacy job cannot be placed, never starts, or behaves differently on one platform than on another.
  • A relay's secret has been lost or exposed, or a relay has to be renamed or removed — including one that still has jobs.

A Universal Agent job never involves a relay; start with the agent instead.

How

  1. Register the relay on Agents › Relays with New Relay, and download its credentials.json before you close the dialog.
  2. Install the relay on a host in your network with the installer for its platform, copy the downloaded credentials.json over the placeholder, and start the service. On Windows the installer refuses folders a non-administrator could change, and only one relay runs on a host at a time.
  3. Register the agents behind it on the Agents tab.
  4. Upgrade it with each platform release by re-running the new package's installer, which keeps the existing settings, and check its Version on the Relays tab afterwards. On Windows the installer stops and restarts the relay for you; on Linux, stop it first and start it after.

The full steps are in Manage relays.

Notes
  • The client secret is shown once, when the relay is registered or its credentials are rotated. If it is lost, rotate the credentials rather than registering the relay again.
  • A newly registered relay reads Offline, with a last heartbeat of Never, until the installed relay first checks in.
  • Legacy agents show Unknown when their relay is stale — the relay, not the agent, is the thing to check. If the relay stays gone for an hour, they read Offline.
  • Stop a relay cleanly when you can: it reads offline in about a second, rather than after about two minutes of missed heartbeats.
  • A clean stop can take up to about 35 seconds while the relay finishes its shutdown.
  • A relay started twice serves from one process only. The other waits as a standby, shown on the Relays tab as an instances badge, and takes over without a restart if the first stops — within seconds on a clean stop, about 40 seconds on a crash — with no offline notifications. An online relay with one process and no standby shows No Standby.
  • Hand Over, on a ready standby's row in Edit Relay, moves the relay to that standby on purpose, for planned maintenance. It needs Relays Edit and cannot be cancelled once it starts.
  • The relay is not upgraded for you. The Relays tab's Version column shows the build each relay runs, so compare it with the version Download Relay offers; — on a relay that checks in means a build from before relays reported their version.
  • The Relays tab needs Relays View, and each action its Relays permission. A relay's legacy agents follow the Agents permissions.
  • If the LSAM Connector restarts, the relay connects it to its legacy machines again by itself.
  • Mark Offline on a legacy agent has its relay close that agent's connection, and Clear Mark opens a new one, without touching the relay's other agents. An older relay keeps the connection open, and the agent's status says so.
Watch out
  • A Windows relay installed with a non-default -ServiceName needs that -ServiceName on every re-run of the installer; without it the installer looks for the default relay's settings instead.
  • Many current behaviours need a current relay — newer job types, IBM i lists, advanced exit criteria, an IBM i job's message ID, the schedule date a legacy job is sent with. An older relay can refuse a job, or quietly drop part of it.
  • Upgrade the relay with the platform release, not separately: a mismatch either way stops new jobs' output from being found.
  • Deleting a relay that still has jobs ends them: they fail and are not retried. The relay must have stopped at least a minute earlier, and it needs Agents Delete as well.
  • When the active relay's host vanishes, the standby cannot reach a legacy agent until the agent's own session timer frees the old session. Check the machine before you rerun a Lost in Failover job: it may still have run.