Experience Agent

The Atlas Experience Agent is a multi-purpose agent that runs on Nodes (PC's) on-premesis connecting the Node/PC to the wider Atlas Experience Manager ecosystem. It is OS-agnostic and currently has builds available for the most common OS's: Debian Linux (aarch64/x64), macOS (aarch64) and Windows 10/11 (x64). A running Experience Agent is the typical representation of a Node in the Experience Manager.

The Agent enables:

• Process Monitoring: To ensure the assigned application is always running. If an application exists for any reason, it is automatically restarted maximizing the uptime and minimizing staff intervention.
• Content Caching: When an Experience Manager CMS Collection is assigned to a Node Template, the content is automatically cached to the Node and made available via a local API with the same interface as the Experience Manager.
• Remote Control: The Agent allows the eemote control Nodes using Cloud Connect allowing for remote application start/stop and Agent restart.

TIP

The Experience Agent can be built for other, less common OS's. Contact Upswell to discuss your build requirements.

Contents

• Installation
• CLI
• APIs
  • Application Environment
  • Cloud Connect
  • CMS Proxy API
  • Node API
  • Image API
  • Universal Application API
• Changelog

Installation

The Experience Agent is installed via guided scripts from the Experience Manager console. See Installation for platform-specific setup instructions for Windows, Linux, and macOS.

CLI

The atlas CLI provides commands for configuring and running the agent. See CLI Usage for the full command reference.

APIs

Not only is the Atlas Experience Agent an automated application runner, it is also a development platform that your application may build upon. The Agent exposes several local HTTP APIs available to applications running on the Node.

Application Environment

When your application is launched via the Experience Agent, environment variables are provided enabling access to local Agent APIs and remote Experience Manager APIs. See Application Environment.

Cloud Connect

Cloud Connect is an MQTT-based distributed messaging system providing real-time control of the Experience Agent. It may also be used by developers to implement custom messaging protocols so that their applications may communicate on-premesis or in the cloud.

Cloud Connect =>

CMS Proxy API

The CMS Proxy API provides limited access to a cached local copy of the Experience Manager CMS records and assets. The CMS Proxy API may be relied on as a RESTful cache for your application, alleviating the need to implement caching within the application itself.

CMS Proxy API =>

Node API

The Node API provides resources to applications running on Nodes, including an API token endpoint to access the Experience Manager and an environment variable endpoint for applications that cannot read directly from the environment.

Node API =>

Image API

The Image API provides on-the-fly media processing, allowing for format conversion, cropping and resizing of images provided by the CMS.

Image API =>

Universal Application API

The Universal Application API provides local hosting by the Experience Agent for Universal Web Applications cached to the Node.

Universal Application API =>

Changelog

See Changelog for version history.