Arc settings.yml File Reference

Arc settings.yml File Reference

The Arc settings file is named settings.yml and is located in the folder where Arc is installed. It controls all Arc server behaviour including TM1 connections, security, Pulse integration, AI assistant, messaging, Atmosphere, and more.

Tip: Lines beginning with # are comments. Uncomment a parameter by removing the leading # and restarting Arc for changes to take effect.

See also: for per-user browser settings (as opposed to this server-side file), see the Arc User Preferences (uiPrefs) Reference. For a short, curated list of the settings from both files that matter most for production stability and performance, see the Arc Best Practice Configuration Guide.

Arc Server

Core settings that control the Arc web server itself.

Parameter

Default

Description

Parameter

Default

Description

portno

7070

The port number Arc listens on, e.g. http://localhost:7070

sessiontimeout

20

Number of minutes before an idle session times out.

licenseExpiryWarningDays

7

Number of days before license expiry to show a warning. Set to 0 to disable.

loggerlevel

INFO

Level of logging for the Arc console and log file. Options: CRITICAL, ERROR, WARNING, NOTICE, INFO, DEBUG.

detailedarccontextinfo

true

Enable detailed info in the context column in Arc Sessions, Pulse, or TM1Top.

commandpath

.\exec

Path to the Python plugin directory.

TM1 Admin Hosts

A list of TM1 Admin Hosts that Arc will connect to in order to discover available TM1 instances. If a server-groups.yml file is present, the adminhosts section in settings.yml is ignored.

The default TM1 Admin Host REST API runs on port 5898 (HTTPS). You can test access by navigating to https://localhost:5898/api/v1/Servers in your browser.

Parameter

Required

Description

Parameter

Required

Description

url

Yes

URL of the TM1 Admin Host, e.g. https://localhost:5898

name

No

A friendly name for the admin host. If omitted, the full URL is used.

pulseenvironment

No*

Name of the Pulse environment linked to this admin host. Required if pulseurl is set. Found in Pulse under Administration > Environments.

pulsetracking

No

Enable Pulse object/user tracking for all instances found on this admin host.

camnamespace

No

Admin host-specific CAM namespace. Use when different admin hosts have different CAM namespaces.

Example:

adminhosts: - url: https://localhost:5898 name: LocalServer pulseenvironment: XYZ pulsetracking: true camnamespace: MyNamespace - url: https://anotherserver:5898 name: LocalServer2 pulseenvironment: QWE pulsetracking: false

TM1 Instance Connections

Direct REST API connections to TM1 instances, bypassing the admin host. Useful for cloud environments or when only the REST API port is accessible. If a server-groups.yml file is present, the connections section is ignored.

Test connectivity by appending /api/v1/$metadata to the base URL, e.g. https://remoteserver.com:8882/api/v1/$metadata. The /api/v1 prefix is appended automatically unless isfullpath: true is set.

Parameter

Required

Description

Parameter

Required

Description

url

Yes

Base URL of the TM1 REST API.

name

No

A friendly name for the connection. If omitted, the instance name is used.

isfullpath

No

Set to true if the URL already contains the full API path (e.g. when using a proxy).

pulseenvironment

No*

Name of the Pulse environment linked to this connection. Required if pulseurl is set.

pulseinstance

No*

TM1 instance name as it appears in Pulse. Required if the connection name differs from the instance name.

pulsetracking

No

Enable Pulse object/user tracking for this instance.

camnamespace

No

Connection-specific CAM namespace.

openidconfiguration

No

Discovery URL of the OIDC provider for this connection.

openidclientid

No

Client ID provided by your OIDC provider.

openidsecretid

No

Client secret provided by your OIDC provider.