Getting Started with Arc
Getting Started with Arc
This is the recommended starting point for all new Arc installations. Follow the steps below to get Arc up and running.
Prerequisites
Arc requires TM1 11+ (Planning Analytics 2+). Some features work with TM1 10.2.2, but important APIs are only present in TM1 11+.
Enable the TM1 REST API
The TM1 REST API is required for Arc to function. Enable it by setting HTTPPortNumber in the tm1s.cfg file:
HTTPPortNumber=8111For full instructions, see: Enabling the TM1 REST API
Step 1: Decide Where to Install Arc
Arc can run on a single laptop, on the TM1 server, or on a dedicated server. See Where to Install Arc for TM1 for a full breakdown of deployment options and trade-offs.
If your TM1 instances are hosted on IBM PA SaaS, jump directly to: Using Arc when TM1 instances are hosted on the IBM Cloud SaaS
Step 2: Choose Your Platform and Install
Select the guide that matches your platform:
Platform | Guide |
|---|---|
Windows (Arc Server) | Getting Started with Arc Server on Windows |
Linux (Arc Server) | Getting Started with Arc Server on Linux |
Mac (Arc Server) | Getting Started with Arc Server on Mac |
Windows (Arc Desktop app) | Getting Started with Arc Desktop for Windows |
Cloud / IBM PA SaaS | Getting Started with Arc on the Cloud |
Step 3: Activate Your License
After starting Arc for the first time, you will need to either start a trial or activate a purchased subscription. See Trialling and Buying Arc for the full process.
Step 4: Connect to TM1
Arc uses the TM1 REST API to connect to TM1 instances. Once installed, configure your connections in the settings.yml file. See the Connecting to TM1 Instances section for all connection options.