Appearance
Application Environment Variables
When the Experience Agent launches an Application, environment variables are provided to the Application allowing it to take advantage of Experience Agent and Experience Manager functionality without seperately managed configuration.
The document details the environment variables provided along with references for how to utilize these features in your application.
Variables are grouped via function below.
TIP
For applications that cannot read from the environment such as web apps, an API providing a limited set of variables is available, see: Experience Agent API.
Environment Variables
Application (Current)
The following variables are provided with information about the application itself as provided by the Experience Manager.
INFO
When using the API, the XOT_APPLICATION_* variables are not available since they are set at launch-time for a specific application.
| Variable | Description | Introduced |
|---|---|---|
XOT_APPLICATION_GIT_HASH | The Git hash of running application, provided at the time of upload to the Experience Manager. | 3.1 |
XOT_APPLICATION_ID | The Experience Manager uuid of the running application. | 3.1 |
XOT_APPLICATION_NS | The namespace assigned to the running application, necessary for features like metrics capture. | 3.1 |
XOT_APPLICATION_VERSION | The Experience Manager version assigned to/by the running application. | 3.1 |
Credentials
TIP
While the XOT_USERNAME and XOT_PASSWORD are provided allowing you to obtain Experience Manager API tokens directly within your application, it is generally recommended that API tokens be acquired via the Experience Agent API token endpoint.
| Variable | Description | Introduced |
|---|---|---|
XOT_USERNAME | The Node username, this may be used with XOT_ENDPOINT_TOKEN endpoint when direct interaction with the experience manager are needed. | 3.0 |
XOT_PASSWORD | The Node password, this may be used with XOT_ENDPOINT_TOKEN endpoint when direct interaction with the experience manager are needed. | 3.0 |
Experience Agent
| Variable | Description | Introduced |
|---|---|---|
XOT_APP_ID | The Experience Manager uuid of the Experience Agent, typically used with health checks and other non-POST requestes to the Experience Manager. | 3.1 |
Experience Agent API's
WARNING
The Experience Agent API's are unstable and breaking changes may be introduced. Please check with Upswell for guidance if you plan to use these API's.
| Variable | Description |
|---|---|
AGENT_HOST | The URL for the build in host API, no trailing slash (i.e. https://localhost:8002) |
AGENT_ENDPOINT_ENVIRONMENT | The complete URL for the Environment Variables API endpoint (a limited set of the vars documented here for use with web applications). |
AGENT_ENDPOINT_METRICS_CAPTURE | The complete URL for the Metrics Capture endpoint (see: Matrics Capture) |
AGENT_ENDPOINT_TOKEN | The complete URL for the Token endpoint, providing the latest Bearer token for Experience Manager access |
AGENT_ENDPOINT_WS | The complete URL for the Experience Agent Websocket providing real-time interaction and activity from the Agent |
Experience Manager
The following variables provide details on the Experience Manager host, and common API endpoints so that they do not need to be constructed in-app:
| Variable | Description | Introduced |
|---|---|---|
XOT_AUTH_HEADER_KEY | The authentication header name, typically Authorization to use when interacting with the Experience Manager API’s. | 3.0 |
XOT_AUTH_PREFIX | The authentication token prefix to prepend to the token for the value of the XOT_AUTH_HEADER_KEY header. | 3.0 |
XOT_HOST | The hosname, of the connected Experience Manager, no trailing slash (i.e. https://example.com). | 3.0 |
XOT_ENDPOINT_NODE | The complete URL for the Node’s, Node configuration/detail API endpoint. | 3.0 |
XOT_ENDPOINT_TOKEN | The complete URL to the Experience Manager Token issuance endpoint. | 3.0 |
For details on API usage, see: Experience Manager API
MQTT (Cloud Connect)
The MQTT/Cloud Connect variables allow applications launched via the Atlas Agent to utilize the Atlas Experience Manager MQTT installation in their own appplications.
| Variable | Description | Introduced |
|---|---|---|
XOT_MQTT_ALLOW_INSECURE | Bool as string literal True/False indicating if TLS certification validation can be ignored | 3.1.9 |
XOT_MQTT_ENABLED | Bool as string literal True/False indicating if MQTT is available | 3.1.9 |
XOT_MQTT_USE_SSL | Bool as string literal True/False indicating if MQTT support non-TLS connections. | 3.1.9 |
XOT_MQTT_URI | The MQTT host URI | 3.1.9 |
XOT_MQTT_URI_WS | The MQTT websocket host URL (for use with browser based connections) | 3.1.9 |
XOT_MQTT_PORT | The MQTT connection port | 3.1.9 |
XOT_MQTT_PORT_WS | The MQTT websocket connection port | 3.1.9 |
XOT_MQTT_TLS_VERSION | (Deprecated) Pinned to tls1.3 for legacy application support | 3.1.9 |
XOT_MQTT_USERNAME | (Deprecated) The Node username, will match XOT_USERNAME | 3.1.9 |
XOT_MQTT_PASSWORD | (Deprecated) The Node password, will match XOT_PASSWORD | 3.1.9 |
For details on Cloud Connect usage, see: Atlas Cloud Connect
Node
Details on the current Node.
| Variable | Description | Introduced |
|---|---|---|
XOT_NODE_ALIAS | The Node alias (readable name), | 3.1 |
XOT_NODE_NANOID | The Node nanoid | 3.1 |
XOT_NODE_UUID | The Node uuid | 3.1 |