Arc settings.yml File Reference

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, Pulse integration, naming conventions, layout, and security.


Connection to TM1

Parameter

Description

Parameter

Description

adminhosts

Connect to TM1 instances via the TM1 Admin Host. Add one entry per admin host server.

connections

Connect directly to a TM1 instance via its REST API URL. Used when only the REST API port is accessible (e.g. cloud environments).

timeoutseconds

Number of seconds Arc waits before timing out when connecting to a TM1 Admin Host or REST API.

usecamredirect

When using a CAM gateway, use redirect instead of iframe.

instancestohide

List of TM1 instance names to hide from the Arc instance list. Useful for unavailable or blocked instances.

useadminhostname

Replace the IP address returned by the admin host (which may be private/internal) with the admin host name. Useful when connecting to TM1 on a remote server.


Connection to Pulse

Parameter

Description

Parameter

Description

pulseurl

Base URL of your Pulse 6+ server, e.g. http://localhost:8099

pulseintervalservice

Polling interval for Pulse service data

pulseintervalchange

Polling interval for Pulse change detection


Naming Conventions

Parameter

Description

Parameter

Description

processnaming

Prefix convention for new parameters and variables in TI processes

rulenamingscript

Path to a JavaScript file that customises function and snippet naming in the Rules editor

processnamingscript

Path to a JavaScript file that customises function and snippet naming in the Process editor


General Settings

Parameter

Description

Parameter

Description

portno

The port Arc listens on (default: 7070)

sessiontimeout

Number of minutes before an idle session times out

loggerlevel

Level of logging to display in the Arc console and log file

commandpath

Folder name where Python command files are stored


Layout

Parameter

Description

Parameter

Description

serverlabel

A name to display in the Arc menu bar, e.g. development or production

serverlabelcolor

A hex color for the server label, e.g. "#f5c311"

hideauthorizeduserlabel

When true, hides the license email address from the Arc menu bar


Security

Parameter

Default

Description

Parameter

Default

Description

usessl

false

Run Arc over HTTPS instead of HTTP

sslhostname

Custom hostname for SSL certificate generation

useletsencrypt

false

Use Let's Encrypt for automated SSL certificate management

usesecuretls

false

Restrict Arc to TLS v1.2+ and secure cipher suites only

usehsts

false

Enable HTTP Strict Transport Security header (forces HTTPS)

usecontentsecuritypolicy

false

Enable Content Security Policy header

useiframedeny

false

Add X-Frame-Options: DENY header to block iframe embedding


Related Pages