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.

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.
`openiduseidtokenforbearer`	No	Use the ID Token instead of the Access Token for the Bearer header. Required for IBM's OpenID implementation (PA v12).
`openidstrictmode`	No	Force the OpenID flow even when 401 response headers do not contain enough information to auto-detect it.
`authstrictmode`	No	Force a specific auth mode: `1` = Basic (default), `8` = IBM API Key.

Example:

connections:
- url: https://remoteserver.com:8882
  name: cloud
  pulseenvironment: ENV1
  pulsetracking: true
- url: https://remoteserver.com:8883
  name: cloud3
  openidconfiguration: https://idp.example.com/.well-known/openid-configuration
  openidclientid: X1234567
  openidsecretid: YYYYYYYYYYY
  openiduseidtokenforbearer: true
  openidstrictmode: true

Additional Connection Settings

Parameter	Default	Description

Parameter	Default	Description
`instancestohide`	—	List of TM1 instance names to hide from the Arc instance list. Accepts YAML list or inline array syntax.
`timeoutseconds`	`10`	Seconds to wait for Arc to connect to a TM1 Admin Host or REST API.
`usecamredirect`	`false`	Use redirect instead of iframe for CAM gateway. Recommended when using SSO or a federated setup.
`useadminhostname`	`false`	Replace the private IP address returned by the admin host with the admin host name. Useful for remote servers.

Security

Settings that control SSL/TLS, HTTP security headers, and content security policy.

Parameter	Default	Description

Parameter	Default	Description
`usessl`	`false`	Run Arc over HTTPS instead of HTTP. A self-signed certificate is generated by default using the server name. Place custom `ssl/cert.pem` and `ssl/key.pem` files in the Arc directory to use your own certificate.
`sslhostname`	—	Custom hostname for SSL certificate generation. Use when a DNS name differs from the machine name.
`useletsencrypt`	`false`	Use Let's Encrypt for automated SSL certificates. Requires Arc to be publicly accessible on ports 80 and 443. `sslhostname` must match your DNS entry.
`usesecuretls`	`false`	Restrict to TLS v1.2+ with secure cipher suites only (ECDHE with AES-GCM or CHACHA20-POLY1305).
`usehsts`	`false`	Enable HTTP Strict Transport Security (HSTS) header. Sets max-age to 2 years including subdomains. To remove, set to `false` and clear the browser HSTS cache.
`addpreloadonhsts`	`false`	Add the `preload` directive to the HSTS header for browser HSTS preload list support.
`usecontentsecuritypolicy`	`false`	Enable Content-Security-Policy header. Restricts connections to known sources. External scripts in plugins will be blocked.
`cspdenyiframeblobs`	`false`	When CSP is enabled, omit `iframe-src 'self' blob:`. Safer but forces PDF downloads instead of in-browser display.
`useiframedeny`	`false`	Add `X-Frame-Options: DENY` header to block iframe embedding.

Naming Conventions

Customise how Arc names functions, snippets, parameters, and variables in the Rules and Process editors.

Parameter	Default	Description

Parameter	Default	Description
`rulenamingscript`	—	JavaScript file in the `naming` directory for Rules editor naming. Built-in options: `uppercase.js`, `lowercase.js`.
`processnamingscript`	—	JavaScript file in the `naming` directory for Process editor naming.

Process Naming Prefixes

The processnaming block controls prefixes Arc uses for new parameters and variables in TI processes. Arc also uses these prefixes for auto-matching variables to dimensions in CELLGET/CELLPUT functions.

Parameter	Default	Description

Parameter	Default	Description
`variablestring`	`v`	Prefix for string variables.
`variablenumeric`	`v`	Prefix for numeric variables.
`parameterstring`	`p`	Prefix for string parameters.
`parameternumeric`	`p`	Prefix for numeric parameters.
`constantstring`	`c`	Prefix for string constants.
`constantnumeric`	`c`	Prefix for numeric constants.
`numeric`	`n`	Prefix for generic numeric types.
`string`	`s`	Prefix for generic string types.
`parameterrequiredstring`	`required:\|$required$`	Regex to identify required parameters from the Prompt field.
`parameteroptionalstring`	`optional:\|$optional$`	Regex to identify optional parameters from the Prompt field.

Pulse Integration

Settings that connect Arc to a Pulse 6+ server for change tracking, instance discovery, and access control.

Parameter	Default	Description

Parameter	Default	Description
`pulseurl`	—	Base URL of your Pulse 6+ server, e.g. `http://localhost:8099`.
`pulseurloverrides`	—	Map of Server Group names to alternative Pulse URLs for per-group overrides.
`usepulseinstances`	`false`	Get the list of TM1 instances from Pulse instead of from Arc settings files.
`pulseloginrequired`	`false`	Require Arc users to be logged in to Pulse before accessing TM1 instances.
`pulseinstanceaccessrequired`	`false`	Require Pulse instance-level access for a user to access an instance in Arc.
`hidepulseintegration`	`false`	Hide Pulse-related UI elements in the Arc application.
`pulseintervalservice`	`1`	Seconds between requests to the Pulse server for service status.
`pulseintervalchange`	`3`	Seconds between requests to the Pulse server for change tracking information.
`processdebugsleeptime`	`10`	Milliseconds Arc waits before polling process debug status.

Example (per-group Pulse URL overrides):

pulseurloverrides:
  ServerGroup01: https://server01.yourpulse.com/
  ServerGroup02: https://server02.yourpulse.com/

Arc UI

Settings that control the appearance and behaviour of the Arc user interface.

Parameter	Default	Description

Parameter	Default	Description
`camnamespace`	—	Global CAM namespace to pre-populate the login screen with. Applies to all admin hosts and connections.
`rollupoptionstohide`	—	List of rollup options to hide in the Subset Editor dialog, e.g. `stddev`, `median`.
`serverlabel`	—	A name to display in the Arc menu bar, e.g. `development` or `production`.
`serverlabelcolor`	—	Hex colour for the server label, e.g. `"#f5c311"`.
`disablestartpopup`	`false`	Set to `true` to disable the release notes pop-up on start.
`hideauthorizeduserlabel`	`false`	Hide the authorized user email from the top bar.
`number.thousand`	—	Thousands separator for number formatting in the Cube Viewer, e.g. `"."`. Overridable per user. Requires Arc restart.
`number.decimal`	—	Decimal separator for number formatting in the Cube Viewer, e.g. `","`. Overridable per user. Requires Arc restart.

Arc AI Assistant

Settings to enable and configure the AI assistant integrated in Arc.

Parameter	Default	Description

Parameter	Default	Description
`enablearcassistant`	`true`	Enable or disable the Arc AI Assistant.
`aiserviceapikey`	—	API key for the AI service. Can also be set in client settings or via the `AI_SERVICE_API_KEY` environment variable.
`aiserviceprovider`	`openai`	AI service provider. Options: `openai`, `ollama`, `huggingface`, `watsonx`. Use `openai` for any OpenAI-compatible service (e.g. GROQ).
`aiserviceurl`	—	Custom server URL for the AI provider. Leave empty to use the default OpenAI endpoint.
`aillmname`	`chatgpt-4o-latest`	Name of the LLM model to use.
`aimaxtokens`	—